Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Akeyless Provider
  3. API Docs
  4. RotatedSecretAws
akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community
akeyless-community/terraform-provider-akeyless

akeyless.RotatedSecretAws

Explore with Pulumi AI

akeyless logo
akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community
akeyless-community/terraform-provider-akeyless

    Aws rotated secret resource

    Create RotatedSecretAws Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new RotatedSecretAws(name: string, args: RotatedSecretAwsArgs, opts?: CustomResourceOptions);
    @overload
def RotatedSecretAws(resource_name: str,
                     args: RotatedSecretAwsArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def RotatedSecretAws(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     rotator_type: Optional[str] = None,
                     target_name: Optional[str] = None,
                     key: Optional[str] = None,
                     auto_rotate: Optional[str] = None,
                     description: Optional[str] = None,
                     grace_rotation: Optional[str] = None,
                     api_id: Optional[str] = None,
                     name: Optional[str] = None,
                     password_length: Optional[str] = None,
                     rotated_secret_aws_id: Optional[str] = None,
                     rotation_hour: Optional[float] = None,
                     rotation_interval: Optional[str] = None,
                     authentication_credentials: Optional[str] = None,
                     tags: Optional[Sequence[str]] = None,
                     api_key: Optional[str] = None)
    func NewRotatedSecretAws(ctx *Context, name string, args RotatedSecretAwsArgs, opts ...ResourceOption) (*RotatedSecretAws, error)
    public RotatedSecretAws(string name, RotatedSecretAwsArgs args, CustomResourceOptions? opts = null)
    public RotatedSecretAws(String name, RotatedSecretAwsArgs args)
public RotatedSecretAws(String name, RotatedSecretAwsArgs args, CustomResourceOptions options)

    type: akeyless:RotatedSecretAws
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args RotatedSecretAwsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args RotatedSecretAwsArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args RotatedSecretAwsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RotatedSecretAwsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RotatedSecretAwsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var rotatedSecretAwsResource = new Akeyless.RotatedSecretAws("rotatedSecretAwsResource", new()
{
    RotatorType = "string",
    TargetName = "string",
    Key = "string",
    AutoRotate = "string",
    Description = "string",
    GraceRotation = "string",
    ApiId = "string",
    Name = "string",
    PasswordLength = "string",
    RotatedSecretAwsId = "string",
    RotationHour = 0,
    RotationInterval = "string",
    AuthenticationCredentials = "string",
    Tags = new[]
    {
        "string",
    },
    ApiKey = "string",
});

    example, err := akeyless.NewRotatedSecretAws(ctx, "rotatedSecretAwsResource", &akeyless.RotatedSecretAwsArgs{
	RotatorType:               pulumi.String("string"),
	TargetName:                pulumi.String("string"),
	Key:                       pulumi.String("string"),
	AutoRotate:                pulumi.String("string"),
	Description:               pulumi.String("string"),
	GraceRotation:             pulumi.String("string"),
	ApiId:                     pulumi.String("string"),
	Name:                      pulumi.String("string"),
	PasswordLength:            pulumi.String("string"),
	RotatedSecretAwsId:        pulumi.String("string"),
	RotationHour:              pulumi.Float64(0),
	RotationInterval:          pulumi.String("string"),
	AuthenticationCredentials: pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	ApiKey: pulumi.String("string"),
})

    var rotatedSecretAwsResource = new RotatedSecretAws("rotatedSecretAwsResource", RotatedSecretAwsArgs.builder()
    .rotatorType("string")
    .targetName("string")
    .key("string")
    .autoRotate("string")
    .description("string")
    .graceRotation("string")
    .apiId("string")
    .name("string")
    .passwordLength("string")
    .rotatedSecretAwsId("string")
    .rotationHour(0)
    .rotationInterval("string")
    .authenticationCredentials("string")
    .tags("string")
    .apiKey("string")
    .build());

    rotated_secret_aws_resource = akeyless.RotatedSecretAws("rotatedSecretAwsResource",
    rotator_type="string",
    target_name="string",
    key="string",
    auto_rotate="string",
    description="string",
    grace_rotation="string",
    api_id="string",
    name="string",
    password_length="string",
    rotated_secret_aws_id="string",
    rotation_hour=0,
    rotation_interval="string",
    authentication_credentials="string",
    tags=["string"],
    api_key="string")

    const rotatedSecretAwsResource = new akeyless.RotatedSecretAws("rotatedSecretAwsResource", {
    rotatorType: "string",
    targetName: "string",
    key: "string",
    autoRotate: "string",
    description: "string",
    graceRotation: "string",
    apiId: "string",
    name: "string",
    passwordLength: "string",
    rotatedSecretAwsId: "string",
    rotationHour: 0,
    rotationInterval: "string",
    authenticationCredentials: "string",
    tags: ["string"],
    apiKey: "string",
});

    type: akeyless:RotatedSecretAws
properties:
    apiId: string
    apiKey: string
    authenticationCredentials: string
    autoRotate: string
    description: string
    graceRotation: string
    key: string
    name: string
    passwordLength: string
    rotatedSecretAwsId: string
    rotationHour: 0
    rotationInterval: string
    rotatorType: string
    tags:
        - string
    targetName: string

    RotatedSecretAws Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The RotatedSecretAws resource accepts the following input properties:

    RotatorType string
    The rotator type [target/api-key]
    TargetName string
    The target name to associate
    ApiId string
    API ID to rotate (relevant only for rotator-type=api-key)
    ApiKey string
    API key to rotate (relevant only for rotator-type=api-key)
    AuthenticationCredentials string
    The credentials to connect with [use-self-creds/use-target-creds]
    AutoRotate string
    Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation
    Description string
    Description of the object
    GraceRotation string
    Create a new access key without deleting the old key from AWS for backup (relevant only for AWS) [true/false]
    Key string
    The name of a key that is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    Name string
    Secret name
    PasswordLength string
    The length of the password to be generated
    RotatedSecretAwsId string
    The ID of this resource.
    RotationHour double
    The Hour of the rotation in UTC
    RotationInterval string
    The number of days to wait between every automatic rotation (1-365),custom rotator interval will be set in minutes
    Tags List<string>
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    RotatorType string
    The rotator type [target/api-key]
    TargetName string
    The target name to associate
    ApiId string
    API ID to rotate (relevant only for rotator-type=api-key)
    ApiKey string
    API key to rotate (relevant only for rotator-type=api-key)
    AuthenticationCredentials string
    The credentials to connect with [use-self-creds/use-target-creds]
    AutoRotate string
    Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation
    Description string
    Description of the object
    GraceRotation string
    Create a new access key without deleting the old key from AWS for backup (relevant only for AWS) [true/false]
    Key string
    The name of a key that is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    Name string
    Secret name
    PasswordLength string
    The length of the password to be generated
    RotatedSecretAwsId string
    The ID of this resource.
    RotationHour float64
    The Hour of the rotation in UTC
    RotationInterval string
    The number of days to wait between every automatic rotation (1-365),custom rotator interval will be set in minutes
    Tags []string
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    rotatorType String
    The rotator type [target/api-key]
    targetName String
    The target name to associate
    apiId String
    API ID to rotate (relevant only for rotator-type=api-key)
    apiKey String
    API key to rotate (relevant only for rotator-type=api-key)
    authenticationCredentials String
    The credentials to connect with [use-self-creds/use-target-creds]
    autoRotate String
    Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation
    description String
    Description of the object
    graceRotation String
    Create a new access key without deleting the old key from AWS for backup (relevant only for AWS) [true/false]
    key String
    The name of a key that is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    name String
    Secret name
    passwordLength String
    The length of the password to be generated
    rotatedSecretAwsId String
    The ID of this resource.
    rotationHour Double
    The Hour of the rotation in UTC
    rotationInterval String
    The number of days to wait between every automatic rotation (1-365),custom rotator interval will be set in minutes
    tags List<String>
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    rotatorType string
    The rotator type [target/api-key]
    targetName string
    The target name to associate
    apiId string
    API ID to rotate (relevant only for rotator-type=api-key)
    apiKey string
    API key to rotate (relevant only for rotator-type=api-key)
    authenticationCredentials string
    The credentials to connect with [use-self-creds/use-target-creds]
    autoRotate string
    Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation
    description string
    Description of the object
    graceRotation string
    Create a new access key without deleting the old key from AWS for backup (relevant only for AWS) [true/false]
    key string
    The name of a key that is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    name string
    Secret name
    passwordLength string
    The length of the password to be generated
    rotatedSecretAwsId string
    The ID of this resource.
    rotationHour number
    The Hour of the rotation in UTC
    rotationInterval string
    The number of days to wait between every automatic rotation (1-365),custom rotator interval will be set in minutes
    tags string[]
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    rotator_type str
    The rotator type [target/api-key]
    target_name str
    The target name to associate
    api_id str
    API ID to rotate (relevant only for rotator-type=api-key)
    api_key str
    API key to rotate (relevant only for rotator-type=api-key)
    authentication_credentials str
    The credentials to connect with [use-self-creds/use-target-creds]
    auto_rotate str
    Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation
    description str
    Description of the object
    grace_rotation str
    Create a new access key without deleting the old key from AWS for backup (relevant only for AWS) [true/false]
    key str
    The name of a key that is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    name str
    Secret name
    password_length str
    The length of the password to be generated
    rotated_secret_aws_id str
    The ID of this resource.
    rotation_hour float
    The Hour of the rotation in UTC
    rotation_interval str
    The number of days to wait between every automatic rotation (1-365),custom rotator interval will be set in minutes
    tags Sequence[str]
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    rotatorType String
    The rotator type [target/api-key]
    targetName String
    The target name to associate
    apiId String
    API ID to rotate (relevant only for rotator-type=api-key)
    apiKey String
    API key to rotate (relevant only for rotator-type=api-key)
    authenticationCredentials String
    The credentials to connect with [use-self-creds/use-target-creds]
    autoRotate String
    Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation
    description String
    Description of the object
    graceRotation String
    Create a new access key without deleting the old key from AWS for backup (relevant only for AWS) [true/false]
    key String
    The name of a key that is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    name String
    Secret name
    passwordLength String
    The length of the password to be generated
    rotatedSecretAwsId String
    The ID of this resource.
    rotationHour Number
    The Hour of the rotation in UTC
    rotationInterval String
    The number of days to wait between every automatic rotation (1-365),custom rotator interval will be set in minutes
    tags List<String>
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RotatedSecretAws resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing RotatedSecretAws Resource

    Get an existing RotatedSecretAws resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: RotatedSecretAwsState, opts?: CustomResourceOptions): RotatedSecretAws
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_id: Optional[str] = None,
        api_key: Optional[str] = None,
        authentication_credentials: Optional[str] = None,
        auto_rotate: Optional[str] = None,
        description: Optional[str] = None,
        grace_rotation: Optional[str] = None,
        key: Optional[str] = None,
        name: Optional[str] = None,
        password_length: Optional[str] = None,
        rotated_secret_aws_id: Optional[str] = None,
        rotation_hour: Optional[float] = None,
        rotation_interval: Optional[str] = None,
        rotator_type: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        target_name: Optional[str] = None) -> RotatedSecretAws
    func GetRotatedSecretAws(ctx *Context, name string, id IDInput, state *RotatedSecretAwsState, opts ...ResourceOption) (*RotatedSecretAws, error)
    public static RotatedSecretAws Get(string name, Input<string> id, RotatedSecretAwsState? state, CustomResourceOptions? opts = null)
    public static RotatedSecretAws get(String name, Output<String> id, RotatedSecretAwsState state, CustomResourceOptions options)
    resources:  _:    type: akeyless:RotatedSecretAws    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApiId string
    API ID to rotate (relevant only for rotator-type=api-key)
    ApiKey string
    API key to rotate (relevant only for rotator-type=api-key)
    AuthenticationCredentials string
    The credentials to connect with [use-self-creds/use-target-creds]
    AutoRotate string
    Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation
    Description string
    Description of the object
    GraceRotation string
    Create a new access key without deleting the old key from AWS for backup (relevant only for AWS) [true/false]
    Key string
    The name of a key that is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    Name string
    Secret name
    PasswordLength string
    The length of the password to be generated
    RotatedSecretAwsId string
    The ID of this resource.
    RotationHour double
    The Hour of the rotation in UTC
    RotationInterval string
    The number of days to wait between every automatic rotation (1-365),custom rotator interval will be set in minutes
    RotatorType string
    The rotator type [target/api-key]
    Tags List<string>
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    TargetName string
    The target name to associate
    ApiId string
    API ID to rotate (relevant only for rotator-type=api-key)
    ApiKey string
    API key to rotate (relevant only for rotator-type=api-key)
    AuthenticationCredentials string
    The credentials to connect with [use-self-creds/use-target-creds]
    AutoRotate string
    Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation
    Description string
    Description of the object
    GraceRotation string
    Create a new access key without deleting the old key from AWS for backup (relevant only for AWS) [true/false]
    Key string
    The name of a key that is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    Name string
    Secret name
    PasswordLength string
    The length of the password to be generated
    RotatedSecretAwsId string
    The ID of this resource.
    RotationHour float64
    The Hour of the rotation in UTC
    RotationInterval string
    The number of days to wait between every automatic rotation (1-365),custom rotator interval will be set in minutes
    RotatorType string
    The rotator type [target/api-key]
    Tags []string
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    TargetName string
    The target name to associate
    apiId String
    API ID to rotate (relevant only for rotator-type=api-key)
    apiKey String
    API key to rotate (relevant only for rotator-type=api-key)
    authenticationCredentials String
    The credentials to connect with [use-self-creds/use-target-creds]
    autoRotate String
    Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation
    description String
    Description of the object
    graceRotation String
    Create a new access key without deleting the old key from AWS for backup (relevant only for AWS) [true/false]
    key String
    The name of a key that is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    name String
    Secret name
    passwordLength String
    The length of the password to be generated
    rotatedSecretAwsId String
    The ID of this resource.
    rotationHour Double
    The Hour of the rotation in UTC
    rotationInterval String
    The number of days to wait between every automatic rotation (1-365),custom rotator interval will be set in minutes
    rotatorType String
    The rotator type [target/api-key]
    tags List<String>
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    targetName String
    The target name to associate
    apiId string
    API ID to rotate (relevant only for rotator-type=api-key)
    apiKey string
    API key to rotate (relevant only for rotator-type=api-key)
    authenticationCredentials string
    The credentials to connect with [use-self-creds/use-target-creds]
    autoRotate string
    Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation
    description string
    Description of the object
    graceRotation string
    Create a new access key without deleting the old key from AWS for backup (relevant only for AWS) [true/false]
    key string
    The name of a key that is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    name string
    Secret name
    passwordLength string
    The length of the password to be generated
    rotatedSecretAwsId string
    The ID of this resource.
    rotationHour number
    The Hour of the rotation in UTC
    rotationInterval string
    The number of days to wait between every automatic rotation (1-365),custom rotator interval will be set in minutes
    rotatorType string
    The rotator type [target/api-key]
    tags string[]
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    targetName string
    The target name to associate
    api_id str
    API ID to rotate (relevant only for rotator-type=api-key)
    api_key str
    API key to rotate (relevant only for rotator-type=api-key)
    authentication_credentials str
    The credentials to connect with [use-self-creds/use-target-creds]
    auto_rotate str
    Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation
    description str
    Description of the object
    grace_rotation str
    Create a new access key without deleting the old key from AWS for backup (relevant only for AWS) [true/false]
    key str
    The name of a key that is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    name str
    Secret name
    password_length str
    The length of the password to be generated
    rotated_secret_aws_id str
    The ID of this resource.
    rotation_hour float
    The Hour of the rotation in UTC
    rotation_interval str
    The number of days to wait between every automatic rotation (1-365),custom rotator interval will be set in minutes
    rotator_type str
    The rotator type [target/api-key]
    tags Sequence[str]
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    target_name str
    The target name to associate
    apiId String
    API ID to rotate (relevant only for rotator-type=api-key)
    apiKey String
    API key to rotate (relevant only for rotator-type=api-key)
    authenticationCredentials String
    The credentials to connect with [use-self-creds/use-target-creds]
    autoRotate String
    Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation
    description String
    Description of the object
    graceRotation String
    Create a new access key without deleting the old key from AWS for backup (relevant only for AWS) [true/false]
    key String
    The name of a key that is used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    name String
    Secret name
    passwordLength String
    The length of the password to be generated
    rotatedSecretAwsId String
    The ID of this resource.
    rotationHour Number
    The Hour of the rotation in UTC
    rotationInterval String
    The number of days to wait between every automatic rotation (1-365),custom rotator interval will be set in minutes
    rotatorType String
    The rotator type [target/api-key]
    tags List<String>
    List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
    targetName String
    The target name to associate

    Package Details

    Repository
    akeyless akeyless-community/terraform-provider-akeyless
    License
    Notes
    This Pulumi package is based on the akeyless Terraform Provider.
    akeyless logo
    akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community
    akeyless-community/terraform-provider-akeyless