1. Packages
  2. AWS Classic
  3. API Docs
  4. secretsmanager
  5. getSecretRotation

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

aws.secretsmanager.getSecretRotation

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

    Retrieve information about a Secrets Manager secret rotation. To retrieve secret metadata, see the aws.secretsmanager.Secret data source. To retrieve a secret value, see the aws.secretsmanager.SecretVersion data source.

    Example Usage

    Retrieve Secret Rotation Configuration

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = aws.secretsmanager.getSecretRotation({
        secretId: exampleAwsSecretsmanagerSecret.id,
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.secretsmanager.get_secret_rotation(secret_id=example_aws_secretsmanager_secret["id"])
    
    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.LookupSecretRotation(ctx, &secretsmanager.LookupSecretRotationArgs{
    			SecretId: exampleAwsSecretsmanagerSecret.Id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Aws.SecretsManager.GetSecretRotation.Invoke(new()
        {
            SecretId = exampleAwsSecretsmanagerSecret.Id,
        });
    
    });
    
    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.GetSecretRotationArgs;
    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 example = SecretsmanagerFunctions.getSecretRotation(GetSecretRotationArgs.builder()
                .secretId(exampleAwsSecretsmanagerSecret.id())
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: aws:secretsmanager:getSecretRotation
          Arguments:
            secretId: ${exampleAwsSecretsmanagerSecret.id}
    

    Using getSecretRotation

    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 getSecretRotation(args: GetSecretRotationArgs, opts?: InvokeOptions): Promise<GetSecretRotationResult>
    function getSecretRotationOutput(args: GetSecretRotationOutputArgs, opts?: InvokeOptions): Output<GetSecretRotationResult>
    def get_secret_rotation(secret_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetSecretRotationResult
    def get_secret_rotation_output(secret_id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetSecretRotationResult]
    func LookupSecretRotation(ctx *Context, args *LookupSecretRotationArgs, opts ...InvokeOption) (*LookupSecretRotationResult, error)
    func LookupSecretRotationOutput(ctx *Context, args *LookupSecretRotationOutputArgs, opts ...InvokeOption) LookupSecretRotationResultOutput

    > Note: This function is named LookupSecretRotation in the Go SDK.

    public static class GetSecretRotation 
    {
        public static Task<GetSecretRotationResult> InvokeAsync(GetSecretRotationArgs args, InvokeOptions? opts = null)
        public static Output<GetSecretRotationResult> Invoke(GetSecretRotationInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSecretRotationResult> getSecretRotation(GetSecretRotationArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws:secretsmanager/getSecretRotation:getSecretRotation
      arguments:
        # arguments dictionary

    The following arguments are supported:

    SecretId string
    Specifies the secret containing the version that you want to retrieve. You can specify either the ARN or the friendly name of the secret.
    SecretId string
    Specifies the secret containing the version that you want to retrieve. You can specify either the ARN or the friendly name of the secret.
    secretId String
    Specifies the secret containing the version that you want to retrieve. You can specify either the ARN or the friendly name of the secret.
    secretId string
    Specifies the secret containing the version that you want to retrieve. You can specify either the ARN or the friendly name of the secret.
    secret_id str
    Specifies the secret containing the version that you want to retrieve. You can specify either the ARN or the friendly name of the secret.
    secretId String
    Specifies the secret containing the version that you want to retrieve. You can specify either the ARN or the friendly name of the secret.

    getSecretRotation Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    RotationEnabled bool
    ARN of the secret.
    RotationLambdaArn string
    Decrypted part of the protected secret information that was originally provided as a string.
    RotationRules List<GetSecretRotationRotationRule>
    Decrypted part of the protected secret information that was originally provided as a binary. Base64 encoded.
    SecretId string
    Id string
    The provider-assigned unique ID for this managed resource.
    RotationEnabled bool
    ARN of the secret.
    RotationLambdaArn string
    Decrypted part of the protected secret information that was originally provided as a string.
    RotationRules []GetSecretRotationRotationRule
    Decrypted part of the protected secret information that was originally provided as a binary. Base64 encoded.
    SecretId string
    id String
    The provider-assigned unique ID for this managed resource.
    rotationEnabled Boolean
    ARN of the secret.
    rotationLambdaArn String
    Decrypted part of the protected secret information that was originally provided as a string.
    rotationRules List<GetSecretRotationRotationRule>
    Decrypted part of the protected secret information that was originally provided as a binary. Base64 encoded.
    secretId String
    id string
    The provider-assigned unique ID for this managed resource.
    rotationEnabled boolean
    ARN of the secret.
    rotationLambdaArn string
    Decrypted part of the protected secret information that was originally provided as a string.
    rotationRules GetSecretRotationRotationRule[]
    Decrypted part of the protected secret information that was originally provided as a binary. Base64 encoded.
    secretId string
    id str
    The provider-assigned unique ID for this managed resource.
    rotation_enabled bool
    ARN of the secret.
    rotation_lambda_arn str
    Decrypted part of the protected secret information that was originally provided as a string.
    rotation_rules Sequence[GetSecretRotationRotationRule]
    Decrypted part of the protected secret information that was originally provided as a binary. Base64 encoded.
    secret_id str
    id String
    The provider-assigned unique ID for this managed resource.
    rotationEnabled Boolean
    ARN of the secret.
    rotationLambdaArn String
    Decrypted part of the protected secret information that was originally provided as a string.
    rotationRules List<Property Map>
    Decrypted part of the protected secret information that was originally provided as a binary. Base64 encoded.
    secretId String

    Supporting Types

    GetSecretRotationRotationRule

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi