AWS Classic
getSecrets
Use this data source to get the ARNs and names of Secrets Manager secrets matching the specified criteria.
Example Usage
using Pulumi;
using Aws = Pulumi.Aws;
class MyStack : Stack
{
public MyStack()
{
var example = Output.Create(Aws.SecretsManager.GetSecrets.InvokeAsync(new Aws.SecretsManager.GetSecretsArgs
{
Filters =
{
new Aws.SecretsManager.Inputs.GetSecretsFilterArgs
{
Name = "name",
Values =
{
"example",
},
},
},
}));
}
}
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/secretsmanager"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := secretsmanager.GetSecrets(ctx, &secretsmanager.GetSecretsArgs{
Filters: []secretsmanager.GetSecretsFilter{
secretsmanager.GetSecretsFilter{
Name: "name",
Values: []string{
"example",
},
},
},
}, nil)
if err != nil {
return err
}
return nil
})
}
package generated_program;
import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = Output.of(SecretsmanagerFunctions.getSecrets(GetSecretsArgs.builder()
.filters(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.build()));
}
}
import pulumi
import pulumi_aws as aws
example = aws.secretsmanager.get_secrets(filters=[aws.secretsmanager.GetSecretsFilterArgs(
name="name",
values=["example"],
)])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = pulumi.output(aws.secretsmanager.getSecrets({
filters: [{
name: "name",
values: ["example"],
}],
}));
variables:
example:
Fn::Invoke:
Function: aws:secretsmanager:getSecrets
Arguments:
filters:
- name: name
values:
- example
Using getSecrets
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getSecrets(args: GetSecretsArgs, opts?: InvokeOptions): Promise<GetSecretsResult>
function getSecretsOutput(args: GetSecretsOutputArgs, opts?: InvokeOptions): Output<GetSecretsResult>
def get_secrets(filters: Optional[Sequence[GetSecretsFilter]] = None,
opts: Optional[InvokeOptions] = None) -> GetSecretsResult
def get_secrets_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetSecretsFilterArgs]]]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetSecretsResult]
func GetSecrets(ctx *Context, args *GetSecretsArgs, opts ...InvokeOption) (*GetSecretsResult, error)
func GetSecretsOutput(ctx *Context, args *GetSecretsOutputArgs, opts ...InvokeOption) GetSecretsResultOutput
> Note: This function is named GetSecrets
in the Go SDK.
public static class GetSecrets
{
public static Task<GetSecretsResult> InvokeAsync(GetSecretsArgs args, InvokeOptions? opts = null)
public static Output<GetSecretsResult> Invoke(GetSecretsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetSecretsResult> getSecrets(GetSecretsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
Function: aws:secretsmanager/getSecrets:getSecrets
Arguments:
# Arguments dictionary
The following arguments are supported:
- Filters
List<Get
Secrets Filter> Configuration block(s) for filtering. Detailed below.
- Filters
[]Get
Secrets Filter Configuration block(s) for filtering. Detailed below.
- filters
List<Get
Secrets Filter> Configuration block(s) for filtering. Detailed below.
- filters
Get
Secrets Filter[] Configuration block(s) for filtering. Detailed below.
- filters
Sequence[Get
Secrets Filter] Configuration block(s) for filtering. Detailed below.
- filters List<Property Map>
Configuration block(s) for filtering. Detailed below.
getSecrets Result
The following output properties are available:
- Arns List<string>
Set of ARNs of the matched Secrets Manager secrets.
- Id string
The provider-assigned unique ID for this managed resource.
- Names List<string>
Set of names of the matched Secrets Manager secrets.
- Filters
List<Get
Secrets Filter>
- Arns []string
Set of ARNs of the matched Secrets Manager secrets.
- Id string
The provider-assigned unique ID for this managed resource.
- Names []string
Set of names of the matched Secrets Manager secrets.
- Filters
[]Get
Secrets Filter
- arns List<String>
Set of ARNs of the matched Secrets Manager secrets.
- id String
The provider-assigned unique ID for this managed resource.
- names List<String>
Set of names of the matched Secrets Manager secrets.
- filters
List<Get
Secrets Filter>
- arns string[]
Set of ARNs of the matched Secrets Manager secrets.
- id string
The provider-assigned unique ID for this managed resource.
- names string[]
Set of names of the matched Secrets Manager secrets.
- filters
Get
Secrets Filter[]
- arns Sequence[str]
Set of ARNs of the matched Secrets Manager secrets.
- id str
The provider-assigned unique ID for this managed resource.
- names Sequence[str]
Set of names of the matched Secrets Manager secrets.
- filters
Sequence[Get
Secrets Filter]
- arns List<String>
Set of ARNs of the matched Secrets Manager secrets.
- id String
The provider-assigned unique ID for this managed resource.
- names List<String>
Set of names of the matched Secrets Manager secrets.
- filters List<Property Map>
Supporting Types
GetSecretsFilter
- Name string
The name of the filter field. Valid values can be found in the Secrets Manager ListSecrets API Reference.
- Values List<string>
Set of values that are accepted for the given filter field. Results will be selected if any given value matches.
- Name string
The name of the filter field. Valid values can be found in the Secrets Manager ListSecrets API Reference.
- Values []string
Set of values that are accepted for the given filter field. Results will be selected if any given value matches.
- name String
The name of the filter field. Valid values can be found in the Secrets Manager ListSecrets API Reference.
- values List<String>
Set of values that are accepted for the given filter field. Results will be selected if any given value matches.
- name string
The name of the filter field. Valid values can be found in the Secrets Manager ListSecrets API Reference.
- values string[]
Set of values that are accepted for the given filter field. Results will be selected if any given value matches.
- name str
The name of the filter field. Valid values can be found in the Secrets Manager ListSecrets API Reference.
- values Sequence[str]
Set of values that are accepted for the given filter field. Results will be selected if any given value matches.
- name String
The name of the filter field. Valid values can be found in the Secrets Manager ListSecrets API Reference.
- values List<String>
Set of values that are accepted for the given filter field. Results will be selected if any given value matches.
Package Details
- Repository
- https://github.com/pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.