get Secret
Retrieve metadata information about a Secrets Manager secret. To retrieve a secret value, see the aws.secretsmanager.SecretVersion
data source.
Example Usage
ARN
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const by_arn = aws.secretsmanager.getSecret({
arn: "arn:aws:secretsmanager:us-east-1:123456789012:secret:example-123456",
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
by_arn = aws.secretsmanager.get_secret(arn="arn:aws:secretsmanager:us-east-1:123456789012:secret:example-123456")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var by_arn = Aws.SecretsManager.GetSecret.Invoke(new()
{
Arn = "arn:aws:secretsmanager:us-east-1:123456789012:secret:example-123456",
});
});
Content copied to clipboard
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/secretsmanager"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := secretsmanager.LookupSecret(ctx, &secretsmanager.LookupSecretArgs{
Arn: pulumi.StringRef("arn:aws:secretsmanager:us-east-1:123456789012:secret:example-123456"),
}, nil)
if err != nil {
return err
}
return nil
})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.secretsmanager.SecretsmanagerFunctions;
import com.pulumi.aws.secretsmanager.inputs.GetSecretArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var by-arn = SecretsmanagerFunctions.getSecret(GetSecretArgs.builder()
.arn("arn:aws:secretsmanager:us-east-1:123456789012:secret:example-123456")
.build());
}
}
Content copied to clipboard
variables:
by-arn:
fn::invoke:
function: aws:secretsmanager:getSecret
arguments:
arn: arn:aws:secretsmanager:us-east-1:123456789012:secret:example-123456
Content copied to clipboard
Name
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const by_name = aws.secretsmanager.getSecret({
name: "example",
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
by_name = aws.secretsmanager.get_secret(name="example")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var by_name = Aws.SecretsManager.GetSecret.Invoke(new()
{
Name = "example",
});
});
Content copied to clipboard
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/secretsmanager"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := secretsmanager.LookupSecret(ctx, &secretsmanager.LookupSecretArgs{
Name: pulumi.StringRef("example"),
}, nil)
if err != nil {
return err
}
return nil
})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.secretsmanager.SecretsmanagerFunctions;
import com.pulumi.aws.secretsmanager.inputs.GetSecretArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var by-name = SecretsmanagerFunctions.getSecret(GetSecretArgs.builder()
.name("example")
.build());
}
}
Content copied to clipboard
variables:
by-name:
fn::invoke:
function: aws:secretsmanager:getSecret
arguments:
name: example
Content copied to clipboard
Return
A collection of values returned by getSecret.
Parameters
argument
A collection of arguments for invoking getSecret.
suspend fun getSecret(arn: String? = null, name: String? = null, tags: Map<String, String>? = null): GetSecretResult
Return
A collection of values returned by getSecret.
Parameters
arn
ARN of the secret to retrieve.
name
Name of the secret to retrieve.
tags
Tags of the secret.
See also
Return
A collection of values returned by getSecret.
Parameters
argument
Builder for com.pulumi.aws.secretsmanager.kotlin.inputs.GetSecretPlainArgs.