AWS Classic

Pulumi Official

Package maintained by Pulumi

v5.10.0 published on Monday, Jul 11, 2022 by Pulumi

getSecretRotation

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

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Aws.SecretsManager.GetSecretRotation.InvokeAsync(new Aws.SecretsManager.GetSecretRotationArgs
        {
            SecretId = data.Aws_secretsmanager_secret.Example.Id,
        }));
    }

}

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.LookupSecretRotation(ctx, &secretsmanager.LookupSecretRotationArgs{
			SecretId: data.Aws_secretsmanager_secret.Example.Id,
		}, 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.getSecretRotation(GetSecretRotationArgs.builder()
            .secretId(data.aws_secretsmanager_secret().example().id())
            .build()));

    }
}

import pulumi
import pulumi_aws as aws

example = aws.secretsmanager.get_secret_rotation(secret_id=data["aws_secretsmanager_secret"]["example"]["id"])

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.secretsmanager.getSecretRotation({
    secretId: data.aws_secretsmanager_secret.example.id,
});

variables:
  example:
    Fn::Invoke:
      Function: aws:secretsmanager:getSecretRotation
      Arguments:
        secretId: ${data.aws_secretsmanager_secret.example.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 Amazon Resource Name (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 Amazon Resource Name (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 Amazon Resource Name (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 Amazon Resource Name (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 Amazon Resource Name (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 Amazon Resource Name (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: The ARN of the secret.
RotationLambdaArn string: The decrypted part of the protected secret information that was originally provided as a string.
RotationRules List<GetSecretRotationRotationRule>: The 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: The ARN of the secret.
RotationLambdaArn string: The decrypted part of the protected secret information that was originally provided as a string.
RotationRules []GetSecretRotationRotationRule: The 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: The ARN of the secret.
rotationLambdaArn String: The decrypted part of the protected secret information that was originally provided as a string.
rotationRules List<GetSecretRotationRotationRule>: The 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: The ARN of the secret.
rotationLambdaArn string: The decrypted part of the protected secret information that was originally provided as a string.
rotationRules GetSecretRotationRotationRule[]: The 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: The ARN of the secret.
rotation_lambda_arn str: The decrypted part of the protected secret information that was originally provided as a string.
rotation_rules Sequence[GetSecretRotationRotationRule]: The 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: The ARN of the secret.
rotationLambdaArn String: The decrypted part of the protected secret information that was originally provided as a string.
rotationRules List<Property Map>: The decrypted part of the protected secret information that was originally provided as a binary. Base64 encoded.
secretId String