Documentation ¶
Index ¶
- type GetSecretRotationRotationRule
- type GetSecretRotationRotationRuleArgs
- func (GetSecretRotationRotationRuleArgs) ElementType() reflect.Type
- func (i GetSecretRotationRotationRuleArgs) ToGetSecretRotationRotationRuleOutput() GetSecretRotationRotationRuleOutput
- func (i GetSecretRotationRotationRuleArgs) ToGetSecretRotationRotationRuleOutputWithContext(ctx context.Context) GetSecretRotationRotationRuleOutput
- type GetSecretRotationRotationRuleArray
- func (GetSecretRotationRotationRuleArray) ElementType() reflect.Type
- func (i GetSecretRotationRotationRuleArray) ToGetSecretRotationRotationRuleArrayOutput() GetSecretRotationRotationRuleArrayOutput
- func (i GetSecretRotationRotationRuleArray) ToGetSecretRotationRotationRuleArrayOutputWithContext(ctx context.Context) GetSecretRotationRotationRuleArrayOutput
- type GetSecretRotationRotationRuleArrayInput
- type GetSecretRotationRotationRuleArrayOutput
- func (GetSecretRotationRotationRuleArrayOutput) ElementType() reflect.Type
- func (o GetSecretRotationRotationRuleArrayOutput) Index(i pulumi.IntInput) GetSecretRotationRotationRuleOutput
- func (o GetSecretRotationRotationRuleArrayOutput) ToGetSecretRotationRotationRuleArrayOutput() GetSecretRotationRotationRuleArrayOutput
- func (o GetSecretRotationRotationRuleArrayOutput) ToGetSecretRotationRotationRuleArrayOutputWithContext(ctx context.Context) GetSecretRotationRotationRuleArrayOutput
- type GetSecretRotationRotationRuleInput
- type GetSecretRotationRotationRuleOutput
- func (o GetSecretRotationRotationRuleOutput) AutomaticallyAfterDays() pulumi.IntOutput
- func (GetSecretRotationRotationRuleOutput) ElementType() reflect.Type
- func (o GetSecretRotationRotationRuleOutput) ToGetSecretRotationRotationRuleOutput() GetSecretRotationRotationRuleOutput
- func (o GetSecretRotationRotationRuleOutput) ToGetSecretRotationRotationRuleOutputWithContext(ctx context.Context) GetSecretRotationRotationRuleOutput
- type GetSecretRotationRule
- type GetSecretRotationRuleArgs
- type GetSecretRotationRuleArray
- func (GetSecretRotationRuleArray) ElementType() reflect.Type
- func (i GetSecretRotationRuleArray) ToGetSecretRotationRuleArrayOutput() GetSecretRotationRuleArrayOutput
- func (i GetSecretRotationRuleArray) ToGetSecretRotationRuleArrayOutputWithContext(ctx context.Context) GetSecretRotationRuleArrayOutput
- type GetSecretRotationRuleArrayInput
- type GetSecretRotationRuleArrayOutput
- func (GetSecretRotationRuleArrayOutput) ElementType() reflect.Type
- func (o GetSecretRotationRuleArrayOutput) Index(i pulumi.IntInput) GetSecretRotationRuleOutput
- func (o GetSecretRotationRuleArrayOutput) ToGetSecretRotationRuleArrayOutput() GetSecretRotationRuleArrayOutput
- func (o GetSecretRotationRuleArrayOutput) ToGetSecretRotationRuleArrayOutputWithContext(ctx context.Context) GetSecretRotationRuleArrayOutput
- type GetSecretRotationRuleInput
- type GetSecretRotationRuleOutput
- func (o GetSecretRotationRuleOutput) AutomaticallyAfterDays() pulumi.IntOutput
- func (GetSecretRotationRuleOutput) ElementType() reflect.Type
- func (o GetSecretRotationRuleOutput) ToGetSecretRotationRuleOutput() GetSecretRotationRuleOutput
- func (o GetSecretRotationRuleOutput) ToGetSecretRotationRuleOutputWithContext(ctx context.Context) GetSecretRotationRuleOutput
- type LookupSecretArgs
- type LookupSecretResult
- type LookupSecretRotationArgs
- type LookupSecretRotationResult
- type LookupSecretVersionArgs
- type LookupSecretVersionResult
- type Secret
- type SecretArgs
- type SecretRotation
- type SecretRotationArgs
- type SecretRotationRotationRules
- type SecretRotationRotationRulesArgs
- func (SecretRotationRotationRulesArgs) ElementType() reflect.Type
- func (i SecretRotationRotationRulesArgs) ToSecretRotationRotationRulesOutput() SecretRotationRotationRulesOutput
- func (i SecretRotationRotationRulesArgs) ToSecretRotationRotationRulesOutputWithContext(ctx context.Context) SecretRotationRotationRulesOutput
- func (i SecretRotationRotationRulesArgs) ToSecretRotationRotationRulesPtrOutput() SecretRotationRotationRulesPtrOutput
- func (i SecretRotationRotationRulesArgs) ToSecretRotationRotationRulesPtrOutputWithContext(ctx context.Context) SecretRotationRotationRulesPtrOutput
- type SecretRotationRotationRulesInput
- type SecretRotationRotationRulesOutput
- func (o SecretRotationRotationRulesOutput) AutomaticallyAfterDays() pulumi.IntOutput
- func (SecretRotationRotationRulesOutput) ElementType() reflect.Type
- func (o SecretRotationRotationRulesOutput) ToSecretRotationRotationRulesOutput() SecretRotationRotationRulesOutput
- func (o SecretRotationRotationRulesOutput) ToSecretRotationRotationRulesOutputWithContext(ctx context.Context) SecretRotationRotationRulesOutput
- func (o SecretRotationRotationRulesOutput) ToSecretRotationRotationRulesPtrOutput() SecretRotationRotationRulesPtrOutput
- func (o SecretRotationRotationRulesOutput) ToSecretRotationRotationRulesPtrOutputWithContext(ctx context.Context) SecretRotationRotationRulesPtrOutput
- type SecretRotationRotationRulesPtrInput
- type SecretRotationRotationRulesPtrOutput
- func (o SecretRotationRotationRulesPtrOutput) AutomaticallyAfterDays() pulumi.IntPtrOutput
- func (o SecretRotationRotationRulesPtrOutput) Elem() SecretRotationRotationRulesOutput
- func (SecretRotationRotationRulesPtrOutput) ElementType() reflect.Type
- func (o SecretRotationRotationRulesPtrOutput) ToSecretRotationRotationRulesPtrOutput() SecretRotationRotationRulesPtrOutput
- func (o SecretRotationRotationRulesPtrOutput) ToSecretRotationRotationRulesPtrOutputWithContext(ctx context.Context) SecretRotationRotationRulesPtrOutput
- type SecretRotationRules
- type SecretRotationRulesArgs
- func (SecretRotationRulesArgs) ElementType() reflect.Type
- func (i SecretRotationRulesArgs) ToSecretRotationRulesOutput() SecretRotationRulesOutput
- func (i SecretRotationRulesArgs) ToSecretRotationRulesOutputWithContext(ctx context.Context) SecretRotationRulesOutput
- func (i SecretRotationRulesArgs) ToSecretRotationRulesPtrOutput() SecretRotationRulesPtrOutput
- func (i SecretRotationRulesArgs) ToSecretRotationRulesPtrOutputWithContext(ctx context.Context) SecretRotationRulesPtrOutput
- type SecretRotationRulesInput
- type SecretRotationRulesOutput
- func (o SecretRotationRulesOutput) AutomaticallyAfterDays() pulumi.IntOutput
- func (SecretRotationRulesOutput) ElementType() reflect.Type
- func (o SecretRotationRulesOutput) ToSecretRotationRulesOutput() SecretRotationRulesOutput
- func (o SecretRotationRulesOutput) ToSecretRotationRulesOutputWithContext(ctx context.Context) SecretRotationRulesOutput
- func (o SecretRotationRulesOutput) ToSecretRotationRulesPtrOutput() SecretRotationRulesPtrOutput
- func (o SecretRotationRulesOutput) ToSecretRotationRulesPtrOutputWithContext(ctx context.Context) SecretRotationRulesPtrOutput
- type SecretRotationRulesPtrInput
- type SecretRotationRulesPtrOutput
- func (o SecretRotationRulesPtrOutput) AutomaticallyAfterDays() pulumi.IntPtrOutput
- func (o SecretRotationRulesPtrOutput) Elem() SecretRotationRulesOutput
- func (SecretRotationRulesPtrOutput) ElementType() reflect.Type
- func (o SecretRotationRulesPtrOutput) ToSecretRotationRulesPtrOutput() SecretRotationRulesPtrOutput
- func (o SecretRotationRulesPtrOutput) ToSecretRotationRulesPtrOutputWithContext(ctx context.Context) SecretRotationRulesPtrOutput
- type SecretRotationState
- type SecretState
- type SecretVersion
- type SecretVersionArgs
- type SecretVersionState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GetSecretRotationRotationRule ¶ added in v2.10.0
type GetSecretRotationRotationRule struct {
AutomaticallyAfterDays int `pulumi:"automaticallyAfterDays"`
}
type GetSecretRotationRotationRuleArgs ¶ added in v2.10.0
type GetSecretRotationRotationRuleArgs struct {
AutomaticallyAfterDays pulumi.IntInput `pulumi:"automaticallyAfterDays"`
}
func (GetSecretRotationRotationRuleArgs) ElementType ¶ added in v2.10.0
func (GetSecretRotationRotationRuleArgs) ElementType() reflect.Type
func (GetSecretRotationRotationRuleArgs) ToGetSecretRotationRotationRuleOutput ¶ added in v2.10.0
func (i GetSecretRotationRotationRuleArgs) ToGetSecretRotationRotationRuleOutput() GetSecretRotationRotationRuleOutput
func (GetSecretRotationRotationRuleArgs) ToGetSecretRotationRotationRuleOutputWithContext ¶ added in v2.10.0
func (i GetSecretRotationRotationRuleArgs) ToGetSecretRotationRotationRuleOutputWithContext(ctx context.Context) GetSecretRotationRotationRuleOutput
type GetSecretRotationRotationRuleArray ¶ added in v2.10.0
type GetSecretRotationRotationRuleArray []GetSecretRotationRotationRuleInput
func (GetSecretRotationRotationRuleArray) ElementType ¶ added in v2.10.0
func (GetSecretRotationRotationRuleArray) ElementType() reflect.Type
func (GetSecretRotationRotationRuleArray) ToGetSecretRotationRotationRuleArrayOutput ¶ added in v2.10.0
func (i GetSecretRotationRotationRuleArray) ToGetSecretRotationRotationRuleArrayOutput() GetSecretRotationRotationRuleArrayOutput
func (GetSecretRotationRotationRuleArray) ToGetSecretRotationRotationRuleArrayOutputWithContext ¶ added in v2.10.0
func (i GetSecretRotationRotationRuleArray) ToGetSecretRotationRotationRuleArrayOutputWithContext(ctx context.Context) GetSecretRotationRotationRuleArrayOutput
type GetSecretRotationRotationRuleArrayInput ¶ added in v2.10.0
type GetSecretRotationRotationRuleArrayInput interface { pulumi.Input ToGetSecretRotationRotationRuleArrayOutput() GetSecretRotationRotationRuleArrayOutput ToGetSecretRotationRotationRuleArrayOutputWithContext(context.Context) GetSecretRotationRotationRuleArrayOutput }
GetSecretRotationRotationRuleArrayInput is an input type that accepts GetSecretRotationRotationRuleArray and GetSecretRotationRotationRuleArrayOutput values. You can construct a concrete instance of `GetSecretRotationRotationRuleArrayInput` via:
GetSecretRotationRotationRuleArray{ GetSecretRotationRotationRuleArgs{...} }
type GetSecretRotationRotationRuleArrayOutput ¶ added in v2.10.0
type GetSecretRotationRotationRuleArrayOutput struct{ *pulumi.OutputState }
func (GetSecretRotationRotationRuleArrayOutput) ElementType ¶ added in v2.10.0
func (GetSecretRotationRotationRuleArrayOutput) ElementType() reflect.Type
func (GetSecretRotationRotationRuleArrayOutput) ToGetSecretRotationRotationRuleArrayOutput ¶ added in v2.10.0
func (o GetSecretRotationRotationRuleArrayOutput) ToGetSecretRotationRotationRuleArrayOutput() GetSecretRotationRotationRuleArrayOutput
func (GetSecretRotationRotationRuleArrayOutput) ToGetSecretRotationRotationRuleArrayOutputWithContext ¶ added in v2.10.0
func (o GetSecretRotationRotationRuleArrayOutput) ToGetSecretRotationRotationRuleArrayOutputWithContext(ctx context.Context) GetSecretRotationRotationRuleArrayOutput
type GetSecretRotationRotationRuleInput ¶ added in v2.10.0
type GetSecretRotationRotationRuleInput interface { pulumi.Input ToGetSecretRotationRotationRuleOutput() GetSecretRotationRotationRuleOutput ToGetSecretRotationRotationRuleOutputWithContext(context.Context) GetSecretRotationRotationRuleOutput }
GetSecretRotationRotationRuleInput is an input type that accepts GetSecretRotationRotationRuleArgs and GetSecretRotationRotationRuleOutput values. You can construct a concrete instance of `GetSecretRotationRotationRuleInput` via:
GetSecretRotationRotationRuleArgs{...}
type GetSecretRotationRotationRuleOutput ¶ added in v2.10.0
type GetSecretRotationRotationRuleOutput struct{ *pulumi.OutputState }
func (GetSecretRotationRotationRuleOutput) AutomaticallyAfterDays ¶ added in v2.10.0
func (o GetSecretRotationRotationRuleOutput) AutomaticallyAfterDays() pulumi.IntOutput
func (GetSecretRotationRotationRuleOutput) ElementType ¶ added in v2.10.0
func (GetSecretRotationRotationRuleOutput) ElementType() reflect.Type
func (GetSecretRotationRotationRuleOutput) ToGetSecretRotationRotationRuleOutput ¶ added in v2.10.0
func (o GetSecretRotationRotationRuleOutput) ToGetSecretRotationRotationRuleOutput() GetSecretRotationRotationRuleOutput
func (GetSecretRotationRotationRuleOutput) ToGetSecretRotationRotationRuleOutputWithContext ¶ added in v2.10.0
func (o GetSecretRotationRotationRuleOutput) ToGetSecretRotationRotationRuleOutputWithContext(ctx context.Context) GetSecretRotationRotationRuleOutput
type GetSecretRotationRule ¶
type GetSecretRotationRule struct {
AutomaticallyAfterDays int `pulumi:"automaticallyAfterDays"`
}
type GetSecretRotationRuleArgs ¶
type GetSecretRotationRuleArgs struct {
AutomaticallyAfterDays pulumi.IntInput `pulumi:"automaticallyAfterDays"`
}
func (GetSecretRotationRuleArgs) ElementType ¶
func (GetSecretRotationRuleArgs) ElementType() reflect.Type
func (GetSecretRotationRuleArgs) ToGetSecretRotationRuleOutput ¶
func (i GetSecretRotationRuleArgs) ToGetSecretRotationRuleOutput() GetSecretRotationRuleOutput
func (GetSecretRotationRuleArgs) ToGetSecretRotationRuleOutputWithContext ¶
func (i GetSecretRotationRuleArgs) ToGetSecretRotationRuleOutputWithContext(ctx context.Context) GetSecretRotationRuleOutput
type GetSecretRotationRuleArray ¶
type GetSecretRotationRuleArray []GetSecretRotationRuleInput
func (GetSecretRotationRuleArray) ElementType ¶
func (GetSecretRotationRuleArray) ElementType() reflect.Type
func (GetSecretRotationRuleArray) ToGetSecretRotationRuleArrayOutput ¶
func (i GetSecretRotationRuleArray) ToGetSecretRotationRuleArrayOutput() GetSecretRotationRuleArrayOutput
func (GetSecretRotationRuleArray) ToGetSecretRotationRuleArrayOutputWithContext ¶
func (i GetSecretRotationRuleArray) ToGetSecretRotationRuleArrayOutputWithContext(ctx context.Context) GetSecretRotationRuleArrayOutput
type GetSecretRotationRuleArrayInput ¶
type GetSecretRotationRuleArrayInput interface { pulumi.Input ToGetSecretRotationRuleArrayOutput() GetSecretRotationRuleArrayOutput ToGetSecretRotationRuleArrayOutputWithContext(context.Context) GetSecretRotationRuleArrayOutput }
GetSecretRotationRuleArrayInput is an input type that accepts GetSecretRotationRuleArray and GetSecretRotationRuleArrayOutput values. You can construct a concrete instance of `GetSecretRotationRuleArrayInput` via:
GetSecretRotationRuleArray{ GetSecretRotationRuleArgs{...} }
type GetSecretRotationRuleArrayOutput ¶
type GetSecretRotationRuleArrayOutput struct{ *pulumi.OutputState }
func (GetSecretRotationRuleArrayOutput) ElementType ¶
func (GetSecretRotationRuleArrayOutput) ElementType() reflect.Type
func (GetSecretRotationRuleArrayOutput) Index ¶
func (o GetSecretRotationRuleArrayOutput) Index(i pulumi.IntInput) GetSecretRotationRuleOutput
func (GetSecretRotationRuleArrayOutput) ToGetSecretRotationRuleArrayOutput ¶
func (o GetSecretRotationRuleArrayOutput) ToGetSecretRotationRuleArrayOutput() GetSecretRotationRuleArrayOutput
func (GetSecretRotationRuleArrayOutput) ToGetSecretRotationRuleArrayOutputWithContext ¶
func (o GetSecretRotationRuleArrayOutput) ToGetSecretRotationRuleArrayOutputWithContext(ctx context.Context) GetSecretRotationRuleArrayOutput
type GetSecretRotationRuleInput ¶
type GetSecretRotationRuleInput interface { pulumi.Input ToGetSecretRotationRuleOutput() GetSecretRotationRuleOutput ToGetSecretRotationRuleOutputWithContext(context.Context) GetSecretRotationRuleOutput }
GetSecretRotationRuleInput is an input type that accepts GetSecretRotationRuleArgs and GetSecretRotationRuleOutput values. You can construct a concrete instance of `GetSecretRotationRuleInput` via:
GetSecretRotationRuleArgs{...}
type GetSecretRotationRuleOutput ¶
type GetSecretRotationRuleOutput struct{ *pulumi.OutputState }
func (GetSecretRotationRuleOutput) AutomaticallyAfterDays ¶
func (o GetSecretRotationRuleOutput) AutomaticallyAfterDays() pulumi.IntOutput
func (GetSecretRotationRuleOutput) ElementType ¶
func (GetSecretRotationRuleOutput) ElementType() reflect.Type
func (GetSecretRotationRuleOutput) ToGetSecretRotationRuleOutput ¶
func (o GetSecretRotationRuleOutput) ToGetSecretRotationRuleOutput() GetSecretRotationRuleOutput
func (GetSecretRotationRuleOutput) ToGetSecretRotationRuleOutputWithContext ¶
func (o GetSecretRotationRuleOutput) ToGetSecretRotationRuleOutputWithContext(ctx context.Context) GetSecretRotationRuleOutput
type LookupSecretArgs ¶
type LookupSecretArgs struct { // The Amazon Resource Name (ARN) of the secret to retrieve. Arn *string `pulumi:"arn"` // The name of the secret to retrieve. Name *string `pulumi:"name"` }
A collection of arguments for invoking getSecret.
type LookupSecretResult ¶
type LookupSecretResult struct { // The Amazon Resource Name (ARN) of the secret. Arn string `pulumi:"arn"` // A description of the secret. Description string `pulumi:"description"` // The provider-assigned unique ID for this managed resource. Id string `pulumi:"id"` // The Key Management Service (KMS) Customer Master Key (CMK) associated with the secret. KmsKeyId string `pulumi:"kmsKeyId"` Name string `pulumi:"name"` // The resource-based policy document that's attached to the secret. Policy string `pulumi:"policy"` // Whether rotation is enabled or not. // // Deprecated: Use the aws_secretsmanager_secret_rotation data source instead RotationEnabled bool `pulumi:"rotationEnabled"` // Rotation Lambda function Amazon Resource Name (ARN) if rotation is enabled. // // Deprecated: Use the aws_secretsmanager_secret_rotation data source instead RotationLambdaArn string `pulumi:"rotationLambdaArn"` // Rotation rules if rotation is enabled. // // Deprecated: Use the aws_secretsmanager_secret_rotation data source instead RotationRules []GetSecretRotationRule `pulumi:"rotationRules"` // Tags of the secret. Tags map[string]string `pulumi:"tags"` }
A collection of values returned by getSecret.
func LookupSecret ¶
func LookupSecret(ctx *pulumi.Context, args *LookupSecretArgs, opts ...pulumi.InvokeOption) (*LookupSecretResult, error)
Retrieve metadata information about a Secrets Manager secret. To retrieve a secret value, see the `secretsmanager.SecretVersion`.
## Example Usage ### ARN
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v2/go/aws/secretsmanager" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { opt0 := "arn:aws:secretsmanager:us-east-1:123456789012:secret:example-123456" _, err := secretsmanager.LookupSecret(ctx, &secretsmanager.LookupSecretArgs{ Arn: &opt0, }, nil) if err != nil { return err } return nil }) }
``` ### Name
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v2/go/aws/secretsmanager" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { opt0 := "example" _, err := secretsmanager.LookupSecret(ctx, &secretsmanager.LookupSecretArgs{ Name: &opt0, }, nil) if err != nil { return err } return nil }) }
```
type LookupSecretRotationArgs ¶ added in v2.10.0
type LookupSecretRotationArgs struct { // Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. SecretId string `pulumi:"secretId"` }
A collection of arguments for invoking getSecretRotation.
type LookupSecretRotationResult ¶ added in v2.10.0
type LookupSecretRotationResult struct { // The provider-assigned unique ID for this managed resource. Id string `pulumi:"id"` // The ARN of the secret. RotationEnabled bool `pulumi:"rotationEnabled"` // The decrypted part of the protected secret information that was originally provided as a string. RotationLambdaArn string `pulumi:"rotationLambdaArn"` // The decrypted part of the protected secret information that was originally provided as a binary. Base64 encoded. RotationRules []GetSecretRotationRotationRule `pulumi:"rotationRules"` SecretId string `pulumi:"secretId"` }
A collection of values returned by getSecretRotation.
func LookupSecretRotation ¶ added in v2.10.0
func LookupSecretRotation(ctx *pulumi.Context, args *LookupSecretRotationArgs, opts ...pulumi.InvokeOption) (*LookupSecretRotationResult, error)
Retrieve information about a Secrets Manager secret rotation. To retrieve secret metadata, see the [`secretsmanager.Secret` data source](https://www.terraform.io/docs/providers/aws/d/secretsmanager_secret.html). To retrieve a secret value, see the [`secretsmanager.SecretVersion` data source](https://www.terraform.io/docs/providers/aws/d/secretsmanager_secret_version.html).
## Example Usage ### Retrieve Secret Rotation Configuration
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v2/go/aws/secretsmanager" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := secretsmanager.LookupSecretRotation(ctx, &secretsmanager.LookupSecretRotationArgs{ SecretId: data.Aws_secretsmanager_secret.Example.Id, }, nil) if err != nil { return err } return nil }) }
```
type LookupSecretVersionArgs ¶
type LookupSecretVersionArgs struct { // Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. SecretId string `pulumi:"secretId"` // Specifies the unique identifier of the version of the secret that you want to retrieve. Overrides `versionStage`. VersionId *string `pulumi:"versionId"` // Specifies the secret version that you want to retrieve by the staging label attached to the version. Defaults to `AWSCURRENT`. VersionStage *string `pulumi:"versionStage"` }
A collection of arguments for invoking getSecretVersion.
type LookupSecretVersionResult ¶
type LookupSecretVersionResult struct { // The ARN of the secret. Arn string `pulumi:"arn"` // The provider-assigned unique ID for this managed resource. Id string `pulumi:"id"` // The decrypted part of the protected secret information that was originally provided as a binary. Base64 encoded. SecretBinary string `pulumi:"secretBinary"` SecretId string `pulumi:"secretId"` // The decrypted part of the protected secret information that was originally provided as a string. SecretString string `pulumi:"secretString"` // The unique identifier of this version of the secret. VersionId string `pulumi:"versionId"` VersionStage *string `pulumi:"versionStage"` VersionStages []string `pulumi:"versionStages"` }
A collection of values returned by getSecretVersion.
func LookupSecretVersion ¶
func LookupSecretVersion(ctx *pulumi.Context, args *LookupSecretVersionArgs, opts ...pulumi.InvokeOption) (*LookupSecretVersionResult, error)
Retrieve information about a Secrets Manager secret version, including its secret value. To retrieve secret metadata, see the `secretsmanager.Secret` data source.
## Example Usage ### Retrieve Current Secret Version
By default, this data sources retrieves information based on the `AWSCURRENT` staging label.
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v2/go/aws/secretsmanager" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := secretsmanager.LookupSecretVersion(ctx, &secretsmanager.LookupSecretVersionArgs{ SecretId: data.Aws_secretsmanager_secret.Example.Id, }, nil) if err != nil { return err } return nil }) }
``` ### Retrieve Specific Secret Version
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v2/go/aws/secretsmanager" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { opt0 := "example" _, err := secretsmanager.LookupSecretVersion(ctx, &secretsmanager.LookupSecretVersionArgs{ SecretId: data.Aws_secretsmanager_secret.Example.Id, VersionStage: &opt0, }, nil) if err != nil { return err } return nil }) }
```
type Secret ¶
type Secret struct { pulumi.CustomResourceState // Amazon Resource Name (ARN) of the secret. Arn pulumi.StringOutput `pulumi:"arn"` // A description of the secret. Description pulumi.StringPtrOutput `pulumi:"description"` // Specifies the ARN or alias of the AWS KMS customer master key (CMK) to be used to encrypt the secret values in the versions stored in this secret. If you don't specify this value, then Secrets Manager defaults to using the AWS account's default CMK (the one named `aws/secretsmanager`). If the default KMS CMK with that name doesn't yet exist, then AWS Secrets Manager creates it for you automatically the first time. KmsKeyId pulumi.StringPtrOutput `pulumi:"kmsKeyId"` // Specifies the friendly name of the new secret. The secret name can consist of uppercase letters, lowercase letters, digits, and any of the following characters: `/_+=.@-` Conflicts with `namePrefix`. Name pulumi.StringOutput `pulumi:"name"` // Creates a unique name beginning with the specified prefix. Conflicts with `name`. NamePrefix pulumi.StringOutput `pulumi:"namePrefix"` // A valid JSON document representing a [resource policy](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-based-policies.html). Policy pulumi.StringPtrOutput `pulumi:"policy"` // Specifies the number of days that AWS Secrets Manager waits before it can delete the secret. This value can be `0` to force deletion without recovery or range from `7` to `30` days. The default value is `30`. RecoveryWindowInDays pulumi.IntPtrOutput `pulumi:"recoveryWindowInDays"` // Specifies whether automatic rotation is enabled for this secret. // // Deprecated: Use the aws_secretsmanager_secret_rotation resource instead RotationEnabled pulumi.BoolOutput `pulumi:"rotationEnabled"` // Specifies the ARN of the Lambda function that can rotate the secret. Use the `secretsmanager.SecretRotation` resource to manage this configuration instead. As of version 2.67.0, removal of this configuration will no longer remove rotation due to supporting the new resource. Either import the new resource and remove the configuration or manually remove rotation. // // Deprecated: Use the aws_secretsmanager_secret_rotation resource instead RotationLambdaArn pulumi.StringOutput `pulumi:"rotationLambdaArn"` // A structure that defines the rotation configuration for this secret. Defined below. Use the `secretsmanager.SecretRotation` resource to manage this configuration instead. As of version 2.67.0, removal of this configuration will no longer remove rotation due to supporting the new resource. Either import the new resource and remove the configuration or manually remove rotation. // // Deprecated: Use the aws_secretsmanager_secret_rotation resource instead RotationRules SecretRotationRulesOutput `pulumi:"rotationRules"` // Specifies a key-value map of user-defined tags that are attached to the secret. Tags pulumi.StringMapOutput `pulumi:"tags"` }
Provides a resource to manage AWS Secrets Manager secret metadata. To manage secret rotation, see the `secretsmanager.SecretRotation` resource. To manage a secret value, see the `secretsmanager.SecretVersion` resource.
## Example Usage ### Basic
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v2/go/aws/secretsmanager" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := secretsmanager.NewSecret(ctx, "example", nil) if err != nil { return err } return nil }) }
``` ### Rotation Configuration
To enable automatic secret rotation, the Secrets Manager service requires usage of a Lambda function. The [Rotate Secrets section in the Secrets Manager User Guide](https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html) provides additional information about deploying a prebuilt Lambda functions for supported credential rotation (e.g. RDS) or deploying a custom Lambda function.
> **NOTE:** Configuring rotation causes the secret to rotate once as soon as you store the secret. Before you do this, you must ensure that all of your applications that use the credentials stored in the secret are updated to retrieve the secret from AWS Secrets Manager. The old credentials might no longer be usable after the initial rotation and any applications that you fail to update will break as soon as the old credentials are no longer valid.
> **NOTE:** If you cancel a rotation that is in progress (by removing the `rotation` configuration), it can leave the VersionStage labels in an unexpected state. Depending on what step of the rotation was in progress, you might need to remove the staging label AWSPENDING from the partially created version, specified by the SecretVersionId response value. You should also evaluate the partially rotated new version to see if it should be deleted, which you can do by removing all staging labels from the new version's VersionStage field.
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v2/go/aws/secretsmanager" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := secretsmanager.NewSecret(ctx, "rotation_example", &secretsmanager.SecretArgs{ RotationLambdaArn: pulumi.String(aws_lambda_function.Example.Arn), RotationRules: &secretsmanager.SecretRotationRulesArgs{ AutomaticallyAfterDays: pulumi.Int(7), }, }) if err != nil { return err } return nil }) }
```
func GetSecret ¶
func GetSecret(ctx *pulumi.Context, name string, id pulumi.IDInput, state *SecretState, opts ...pulumi.ResourceOption) (*Secret, error)
GetSecret gets an existing Secret resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewSecret ¶
func NewSecret(ctx *pulumi.Context, name string, args *SecretArgs, opts ...pulumi.ResourceOption) (*Secret, error)
NewSecret registers a new resource with the given unique name, arguments, and options.
type SecretArgs ¶
type SecretArgs struct { // A description of the secret. Description pulumi.StringPtrInput // Specifies the ARN or alias of the AWS KMS customer master key (CMK) to be used to encrypt the secret values in the versions stored in this secret. If you don't specify this value, then Secrets Manager defaults to using the AWS account's default CMK (the one named `aws/secretsmanager`). If the default KMS CMK with that name doesn't yet exist, then AWS Secrets Manager creates it for you automatically the first time. KmsKeyId pulumi.StringPtrInput // Specifies the friendly name of the new secret. The secret name can consist of uppercase letters, lowercase letters, digits, and any of the following characters: `/_+=.@-` Conflicts with `namePrefix`. Name pulumi.StringPtrInput // Creates a unique name beginning with the specified prefix. Conflicts with `name`. NamePrefix pulumi.StringPtrInput // A valid JSON document representing a [resource policy](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-based-policies.html). Policy pulumi.StringPtrInput // Specifies the number of days that AWS Secrets Manager waits before it can delete the secret. This value can be `0` to force deletion without recovery or range from `7` to `30` days. The default value is `30`. RecoveryWindowInDays pulumi.IntPtrInput // Specifies the ARN of the Lambda function that can rotate the secret. Use the `secretsmanager.SecretRotation` resource to manage this configuration instead. As of version 2.67.0, removal of this configuration will no longer remove rotation due to supporting the new resource. Either import the new resource and remove the configuration or manually remove rotation. // // Deprecated: Use the aws_secretsmanager_secret_rotation resource instead RotationLambdaArn pulumi.StringPtrInput // A structure that defines the rotation configuration for this secret. Defined below. Use the `secretsmanager.SecretRotation` resource to manage this configuration instead. As of version 2.67.0, removal of this configuration will no longer remove rotation due to supporting the new resource. Either import the new resource and remove the configuration or manually remove rotation. // // Deprecated: Use the aws_secretsmanager_secret_rotation resource instead RotationRules SecretRotationRulesPtrInput // Specifies a key-value map of user-defined tags that are attached to the secret. Tags pulumi.StringMapInput }
The set of arguments for constructing a Secret resource.
func (SecretArgs) ElementType ¶
func (SecretArgs) ElementType() reflect.Type
type SecretRotation ¶ added in v2.10.0
type SecretRotation struct { pulumi.CustomResourceState // Specifies whether automatic rotation is enabled for this secret. RotationEnabled pulumi.BoolOutput `pulumi:"rotationEnabled"` // Specifies the ARN of the Lambda function that can rotate the secret. RotationLambdaArn pulumi.StringOutput `pulumi:"rotationLambdaArn"` // A structure that defines the rotation configuration for this secret. Defined below. RotationRules SecretRotationRotationRulesOutput `pulumi:"rotationRules"` // Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist. SecretId pulumi.StringOutput `pulumi:"secretId"` Tags pulumi.StringMapOutput `pulumi:"tags"` }
Provides a resource to manage AWS Secrets Manager secret rotation. To manage a secret, see the [`secretsmanager.Secret` resource](https://www.terraform.io/docs/providers/aws/r/secretsmanager_secret.html). To manage a secret value, see the [`secretsmanager.SecretVersion` resource](https://www.terraform.io/docs/providers/aws/r/secretsmanager_secret_version.html).
## Example Usage ### Basic
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v2/go/aws/secretsmanager" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := secretsmanager.NewSecretRotation(ctx, "example", &secretsmanager.SecretRotationArgs{ RotationLambdaArn: pulumi.String(aws_lambda_function.Example.Arn), RotationRules: &secretsmanager.SecretRotationRotationRulesArgs{ AutomaticallyAfterDays: pulumi.Int(30), }, SecretId: pulumi.String(aws_secretsmanager_secret.Example.Id), }) if err != nil { return err } return nil }) }
``` ### Rotation Configuration
To enable automatic secret rotation, the Secrets Manager service requires usage of a Lambda function. The [Rotate Secrets section in the Secrets Manager User Guide](https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html) provides additional information about deploying a prebuilt Lambda functions for supported credential rotation (e.g. RDS) or deploying a custom Lambda function.
> **NOTE:** Configuring rotation causes the secret to rotate once as soon as you enable rotation. Before you do this, you must ensure that all of your applications that use the credentials stored in the secret are updated to retrieve the secret from AWS Secrets Manager. The old credentials might no longer be usable after the initial rotation and any applications that you fail to update will break as soon as the old credentials are no longer valid.
> **NOTE:** If you cancel a rotation that is in progress (by removing the `rotation` configuration), it can leave the VersionStage labels in an unexpected state. Depending on what step of the rotation was in progress, you might need to remove the staging label AWSPENDING from the partially created version, specified by the SecretVersionId response value. You should also evaluate the partially rotated new version to see if it should be deleted, which you can do by removing all staging labels from the new version's VersionStage field.
func GetSecretRotation ¶ added in v2.10.0
func GetSecretRotation(ctx *pulumi.Context, name string, id pulumi.IDInput, state *SecretRotationState, opts ...pulumi.ResourceOption) (*SecretRotation, error)
GetSecretRotation gets an existing SecretRotation resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewSecretRotation ¶ added in v2.10.0
func NewSecretRotation(ctx *pulumi.Context, name string, args *SecretRotationArgs, opts ...pulumi.ResourceOption) (*SecretRotation, error)
NewSecretRotation registers a new resource with the given unique name, arguments, and options.
type SecretRotationArgs ¶ added in v2.10.0
type SecretRotationArgs struct { // Specifies the ARN of the Lambda function that can rotate the secret. RotationLambdaArn pulumi.StringInput // A structure that defines the rotation configuration for this secret. Defined below. RotationRules SecretRotationRotationRulesInput // Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist. SecretId pulumi.StringInput Tags pulumi.StringMapInput }
The set of arguments for constructing a SecretRotation resource.
func (SecretRotationArgs) ElementType ¶ added in v2.10.0
func (SecretRotationArgs) ElementType() reflect.Type
type SecretRotationRotationRules ¶ added in v2.10.0
type SecretRotationRotationRules struct { // Specifies the number of days between automatic scheduled rotations of the secret. AutomaticallyAfterDays int `pulumi:"automaticallyAfterDays"` }
type SecretRotationRotationRulesArgs ¶ added in v2.10.0
type SecretRotationRotationRulesArgs struct { // Specifies the number of days between automatic scheduled rotations of the secret. AutomaticallyAfterDays pulumi.IntInput `pulumi:"automaticallyAfterDays"` }
func (SecretRotationRotationRulesArgs) ElementType ¶ added in v2.10.0
func (SecretRotationRotationRulesArgs) ElementType() reflect.Type
func (SecretRotationRotationRulesArgs) ToSecretRotationRotationRulesOutput ¶ added in v2.10.0
func (i SecretRotationRotationRulesArgs) ToSecretRotationRotationRulesOutput() SecretRotationRotationRulesOutput
func (SecretRotationRotationRulesArgs) ToSecretRotationRotationRulesOutputWithContext ¶ added in v2.10.0
func (i SecretRotationRotationRulesArgs) ToSecretRotationRotationRulesOutputWithContext(ctx context.Context) SecretRotationRotationRulesOutput
func (SecretRotationRotationRulesArgs) ToSecretRotationRotationRulesPtrOutput ¶ added in v2.10.0
func (i SecretRotationRotationRulesArgs) ToSecretRotationRotationRulesPtrOutput() SecretRotationRotationRulesPtrOutput
func (SecretRotationRotationRulesArgs) ToSecretRotationRotationRulesPtrOutputWithContext ¶ added in v2.10.0
func (i SecretRotationRotationRulesArgs) ToSecretRotationRotationRulesPtrOutputWithContext(ctx context.Context) SecretRotationRotationRulesPtrOutput
type SecretRotationRotationRulesInput ¶ added in v2.10.0
type SecretRotationRotationRulesInput interface { pulumi.Input ToSecretRotationRotationRulesOutput() SecretRotationRotationRulesOutput ToSecretRotationRotationRulesOutputWithContext(context.Context) SecretRotationRotationRulesOutput }
SecretRotationRotationRulesInput is an input type that accepts SecretRotationRotationRulesArgs and SecretRotationRotationRulesOutput values. You can construct a concrete instance of `SecretRotationRotationRulesInput` via:
SecretRotationRotationRulesArgs{...}
type SecretRotationRotationRulesOutput ¶ added in v2.10.0
type SecretRotationRotationRulesOutput struct{ *pulumi.OutputState }
func (SecretRotationRotationRulesOutput) AutomaticallyAfterDays ¶ added in v2.10.0
func (o SecretRotationRotationRulesOutput) AutomaticallyAfterDays() pulumi.IntOutput
Specifies the number of days between automatic scheduled rotations of the secret.
func (SecretRotationRotationRulesOutput) ElementType ¶ added in v2.10.0
func (SecretRotationRotationRulesOutput) ElementType() reflect.Type
func (SecretRotationRotationRulesOutput) ToSecretRotationRotationRulesOutput ¶ added in v2.10.0
func (o SecretRotationRotationRulesOutput) ToSecretRotationRotationRulesOutput() SecretRotationRotationRulesOutput
func (SecretRotationRotationRulesOutput) ToSecretRotationRotationRulesOutputWithContext ¶ added in v2.10.0
func (o SecretRotationRotationRulesOutput) ToSecretRotationRotationRulesOutputWithContext(ctx context.Context) SecretRotationRotationRulesOutput
func (SecretRotationRotationRulesOutput) ToSecretRotationRotationRulesPtrOutput ¶ added in v2.10.0
func (o SecretRotationRotationRulesOutput) ToSecretRotationRotationRulesPtrOutput() SecretRotationRotationRulesPtrOutput
func (SecretRotationRotationRulesOutput) ToSecretRotationRotationRulesPtrOutputWithContext ¶ added in v2.10.0
func (o SecretRotationRotationRulesOutput) ToSecretRotationRotationRulesPtrOutputWithContext(ctx context.Context) SecretRotationRotationRulesPtrOutput
type SecretRotationRotationRulesPtrInput ¶ added in v2.10.0
type SecretRotationRotationRulesPtrInput interface { pulumi.Input ToSecretRotationRotationRulesPtrOutput() SecretRotationRotationRulesPtrOutput ToSecretRotationRotationRulesPtrOutputWithContext(context.Context) SecretRotationRotationRulesPtrOutput }
SecretRotationRotationRulesPtrInput is an input type that accepts SecretRotationRotationRulesArgs, SecretRotationRotationRulesPtr and SecretRotationRotationRulesPtrOutput values. You can construct a concrete instance of `SecretRotationRotationRulesPtrInput` via:
SecretRotationRotationRulesArgs{...} or: nil
func SecretRotationRotationRulesPtr ¶ added in v2.10.0
func SecretRotationRotationRulesPtr(v *SecretRotationRotationRulesArgs) SecretRotationRotationRulesPtrInput
type SecretRotationRotationRulesPtrOutput ¶ added in v2.10.0
type SecretRotationRotationRulesPtrOutput struct{ *pulumi.OutputState }
func (SecretRotationRotationRulesPtrOutput) AutomaticallyAfterDays ¶ added in v2.10.0
func (o SecretRotationRotationRulesPtrOutput) AutomaticallyAfterDays() pulumi.IntPtrOutput
Specifies the number of days between automatic scheduled rotations of the secret.
func (SecretRotationRotationRulesPtrOutput) ElementType ¶ added in v2.10.0
func (SecretRotationRotationRulesPtrOutput) ElementType() reflect.Type
func (SecretRotationRotationRulesPtrOutput) ToSecretRotationRotationRulesPtrOutput ¶ added in v2.10.0
func (o SecretRotationRotationRulesPtrOutput) ToSecretRotationRotationRulesPtrOutput() SecretRotationRotationRulesPtrOutput
func (SecretRotationRotationRulesPtrOutput) ToSecretRotationRotationRulesPtrOutputWithContext ¶ added in v2.10.0
func (o SecretRotationRotationRulesPtrOutput) ToSecretRotationRotationRulesPtrOutputWithContext(ctx context.Context) SecretRotationRotationRulesPtrOutput
type SecretRotationRules ¶
type SecretRotationRules struct { // Specifies the number of days between automatic scheduled rotations of the secret. AutomaticallyAfterDays int `pulumi:"automaticallyAfterDays"` }
type SecretRotationRulesArgs ¶
type SecretRotationRulesArgs struct { // Specifies the number of days between automatic scheduled rotations of the secret. AutomaticallyAfterDays pulumi.IntInput `pulumi:"automaticallyAfterDays"` }
func (SecretRotationRulesArgs) ElementType ¶
func (SecretRotationRulesArgs) ElementType() reflect.Type
func (SecretRotationRulesArgs) ToSecretRotationRulesOutput ¶
func (i SecretRotationRulesArgs) ToSecretRotationRulesOutput() SecretRotationRulesOutput
func (SecretRotationRulesArgs) ToSecretRotationRulesOutputWithContext ¶
func (i SecretRotationRulesArgs) ToSecretRotationRulesOutputWithContext(ctx context.Context) SecretRotationRulesOutput
func (SecretRotationRulesArgs) ToSecretRotationRulesPtrOutput ¶
func (i SecretRotationRulesArgs) ToSecretRotationRulesPtrOutput() SecretRotationRulesPtrOutput
func (SecretRotationRulesArgs) ToSecretRotationRulesPtrOutputWithContext ¶
func (i SecretRotationRulesArgs) ToSecretRotationRulesPtrOutputWithContext(ctx context.Context) SecretRotationRulesPtrOutput
type SecretRotationRulesInput ¶
type SecretRotationRulesInput interface { pulumi.Input ToSecretRotationRulesOutput() SecretRotationRulesOutput ToSecretRotationRulesOutputWithContext(context.Context) SecretRotationRulesOutput }
SecretRotationRulesInput is an input type that accepts SecretRotationRulesArgs and SecretRotationRulesOutput values. You can construct a concrete instance of `SecretRotationRulesInput` via:
SecretRotationRulesArgs{...}
type SecretRotationRulesOutput ¶
type SecretRotationRulesOutput struct{ *pulumi.OutputState }
func (SecretRotationRulesOutput) AutomaticallyAfterDays ¶
func (o SecretRotationRulesOutput) AutomaticallyAfterDays() pulumi.IntOutput
Specifies the number of days between automatic scheduled rotations of the secret.
func (SecretRotationRulesOutput) ElementType ¶
func (SecretRotationRulesOutput) ElementType() reflect.Type
func (SecretRotationRulesOutput) ToSecretRotationRulesOutput ¶
func (o SecretRotationRulesOutput) ToSecretRotationRulesOutput() SecretRotationRulesOutput
func (SecretRotationRulesOutput) ToSecretRotationRulesOutputWithContext ¶
func (o SecretRotationRulesOutput) ToSecretRotationRulesOutputWithContext(ctx context.Context) SecretRotationRulesOutput
func (SecretRotationRulesOutput) ToSecretRotationRulesPtrOutput ¶
func (o SecretRotationRulesOutput) ToSecretRotationRulesPtrOutput() SecretRotationRulesPtrOutput
func (SecretRotationRulesOutput) ToSecretRotationRulesPtrOutputWithContext ¶
func (o SecretRotationRulesOutput) ToSecretRotationRulesPtrOutputWithContext(ctx context.Context) SecretRotationRulesPtrOutput
type SecretRotationRulesPtrInput ¶
type SecretRotationRulesPtrInput interface { pulumi.Input ToSecretRotationRulesPtrOutput() SecretRotationRulesPtrOutput ToSecretRotationRulesPtrOutputWithContext(context.Context) SecretRotationRulesPtrOutput }
SecretRotationRulesPtrInput is an input type that accepts SecretRotationRulesArgs, SecretRotationRulesPtr and SecretRotationRulesPtrOutput values. You can construct a concrete instance of `SecretRotationRulesPtrInput` via:
SecretRotationRulesArgs{...} or: nil
func SecretRotationRulesPtr ¶
func SecretRotationRulesPtr(v *SecretRotationRulesArgs) SecretRotationRulesPtrInput
type SecretRotationRulesPtrOutput ¶
type SecretRotationRulesPtrOutput struct{ *pulumi.OutputState }
func (SecretRotationRulesPtrOutput) AutomaticallyAfterDays ¶
func (o SecretRotationRulesPtrOutput) AutomaticallyAfterDays() pulumi.IntPtrOutput
Specifies the number of days between automatic scheduled rotations of the secret.
func (SecretRotationRulesPtrOutput) Elem ¶
func (o SecretRotationRulesPtrOutput) Elem() SecretRotationRulesOutput
func (SecretRotationRulesPtrOutput) ElementType ¶
func (SecretRotationRulesPtrOutput) ElementType() reflect.Type
func (SecretRotationRulesPtrOutput) ToSecretRotationRulesPtrOutput ¶
func (o SecretRotationRulesPtrOutput) ToSecretRotationRulesPtrOutput() SecretRotationRulesPtrOutput
func (SecretRotationRulesPtrOutput) ToSecretRotationRulesPtrOutputWithContext ¶
func (o SecretRotationRulesPtrOutput) ToSecretRotationRulesPtrOutputWithContext(ctx context.Context) SecretRotationRulesPtrOutput
type SecretRotationState ¶ added in v2.10.0
type SecretRotationState struct { // Specifies whether automatic rotation is enabled for this secret. RotationEnabled pulumi.BoolPtrInput // Specifies the ARN of the Lambda function that can rotate the secret. RotationLambdaArn pulumi.StringPtrInput // A structure that defines the rotation configuration for this secret. Defined below. RotationRules SecretRotationRotationRulesPtrInput // Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist. SecretId pulumi.StringPtrInput Tags pulumi.StringMapInput }
func (SecretRotationState) ElementType ¶ added in v2.10.0
func (SecretRotationState) ElementType() reflect.Type
type SecretState ¶
type SecretState struct { // Amazon Resource Name (ARN) of the secret. Arn pulumi.StringPtrInput // A description of the secret. Description pulumi.StringPtrInput // Specifies the ARN or alias of the AWS KMS customer master key (CMK) to be used to encrypt the secret values in the versions stored in this secret. If you don't specify this value, then Secrets Manager defaults to using the AWS account's default CMK (the one named `aws/secretsmanager`). If the default KMS CMK with that name doesn't yet exist, then AWS Secrets Manager creates it for you automatically the first time. KmsKeyId pulumi.StringPtrInput // Specifies the friendly name of the new secret. The secret name can consist of uppercase letters, lowercase letters, digits, and any of the following characters: `/_+=.@-` Conflicts with `namePrefix`. Name pulumi.StringPtrInput // Creates a unique name beginning with the specified prefix. Conflicts with `name`. NamePrefix pulumi.StringPtrInput // A valid JSON document representing a [resource policy](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-based-policies.html). Policy pulumi.StringPtrInput // Specifies the number of days that AWS Secrets Manager waits before it can delete the secret. This value can be `0` to force deletion without recovery or range from `7` to `30` days. The default value is `30`. RecoveryWindowInDays pulumi.IntPtrInput // Specifies whether automatic rotation is enabled for this secret. // // Deprecated: Use the aws_secretsmanager_secret_rotation resource instead RotationEnabled pulumi.BoolPtrInput // Specifies the ARN of the Lambda function that can rotate the secret. Use the `secretsmanager.SecretRotation` resource to manage this configuration instead. As of version 2.67.0, removal of this configuration will no longer remove rotation due to supporting the new resource. Either import the new resource and remove the configuration or manually remove rotation. // // Deprecated: Use the aws_secretsmanager_secret_rotation resource instead RotationLambdaArn pulumi.StringPtrInput // A structure that defines the rotation configuration for this secret. Defined below. Use the `secretsmanager.SecretRotation` resource to manage this configuration instead. As of version 2.67.0, removal of this configuration will no longer remove rotation due to supporting the new resource. Either import the new resource and remove the configuration or manually remove rotation. // // Deprecated: Use the aws_secretsmanager_secret_rotation resource instead RotationRules SecretRotationRulesPtrInput // Specifies a key-value map of user-defined tags that are attached to the secret. Tags pulumi.StringMapInput }
func (SecretState) ElementType ¶
func (SecretState) ElementType() reflect.Type
type SecretVersion ¶
type SecretVersion struct { pulumi.CustomResourceState // The ARN of the secret. Arn pulumi.StringOutput `pulumi:"arn"` // Specifies binary data that you want to encrypt and store in this version of the secret. This is required if secretString is not set. Needs to be encoded to base64. SecretBinary pulumi.StringPtrOutput `pulumi:"secretBinary"` // Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist. SecretId pulumi.StringOutput `pulumi:"secretId"` // Specifies text data that you want to encrypt and store in this version of the secret. This is required if secretBinary is not set. SecretString pulumi.StringPtrOutput `pulumi:"secretString"` // The unique identifier of the version of the secret. VersionId pulumi.StringOutput `pulumi:"versionId"` // Specifies a list of staging labels that are attached to this version of the secret. A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version. If you do not specify a value, then AWS Secrets Manager automatically moves the staging label `AWSCURRENT` to this new version on creation. VersionStages pulumi.StringArrayOutput `pulumi:"versionStages"` }
Provides a resource to manage AWS Secrets Manager secret version including its secret value. To manage secret metadata, see the `secretsmanager.Secret` resource.
> **NOTE:** If the `AWSCURRENT` staging label is present on this version during resource deletion, that label cannot be removed and will be skipped to prevent errors when fully deleting the secret. That label will leave this secret version active even after the resource is deleted from this provider unless the secret itself is deleted. Move the `AWSCURRENT` staging label before or after deleting this resource from this provider to fully trigger version deprecation if necessary.
## Example Usage ### Simple String Value
```go package main
import (
"github.com/pulumi/pulumi-aws/sdk/v2/go/aws/secretsmanager" "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := secretsmanager.NewSecretVersion(ctx, "example", &secretsmanager.SecretVersionArgs{ SecretId: pulumi.String(aws_secretsmanager_secret.Example.Id), SecretString: pulumi.String("example-string-to-protect"), }) if err != nil { return err } return nil }) }
```
func GetSecretVersion ¶
func GetSecretVersion(ctx *pulumi.Context, name string, id pulumi.IDInput, state *SecretVersionState, opts ...pulumi.ResourceOption) (*SecretVersion, error)
GetSecretVersion gets an existing SecretVersion resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewSecretVersion ¶
func NewSecretVersion(ctx *pulumi.Context, name string, args *SecretVersionArgs, opts ...pulumi.ResourceOption) (*SecretVersion, error)
NewSecretVersion registers a new resource with the given unique name, arguments, and options.
type SecretVersionArgs ¶
type SecretVersionArgs struct { // Specifies binary data that you want to encrypt and store in this version of the secret. This is required if secretString is not set. Needs to be encoded to base64. SecretBinary pulumi.StringPtrInput // Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist. SecretId pulumi.StringInput // Specifies text data that you want to encrypt and store in this version of the secret. This is required if secretBinary is not set. SecretString pulumi.StringPtrInput // Specifies a list of staging labels that are attached to this version of the secret. A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version. If you do not specify a value, then AWS Secrets Manager automatically moves the staging label `AWSCURRENT` to this new version on creation. VersionStages pulumi.StringArrayInput }
The set of arguments for constructing a SecretVersion resource.
func (SecretVersionArgs) ElementType ¶
func (SecretVersionArgs) ElementType() reflect.Type
type SecretVersionState ¶
type SecretVersionState struct { // The ARN of the secret. Arn pulumi.StringPtrInput // Specifies binary data that you want to encrypt and store in this version of the secret. This is required if secretString is not set. Needs to be encoded to base64. SecretBinary pulumi.StringPtrInput // Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist. SecretId pulumi.StringPtrInput // Specifies text data that you want to encrypt and store in this version of the secret. This is required if secretBinary is not set. SecretString pulumi.StringPtrInput // The unique identifier of the version of the secret. VersionId pulumi.StringPtrInput // Specifies a list of staging labels that are attached to this version of the secret. A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version. If you do not specify a value, then AWS Secrets Manager automatically moves the staging label `AWSCURRENT` to this new version on creation. VersionStages pulumi.StringArrayInput }
func (SecretVersionState) ElementType ¶
func (SecretVersionState) ElementType() reflect.Type