RotatedSecretAws

akeyless 2.0.1, Apr 27 26

Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community

akeyless-community/terraform-provider-akeyless

Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community

akeyless-community/terraform-provider-akeyless

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,
                     grace_rotation: Optional[str] = None,
                     secure_access_certificate_issuer: Optional[str] = None,
                     aws_region: Optional[str] = None,
                     delete_protection: Optional[str] = None,
                     description: Optional[str] = None,
                     api_id: Optional[str] = None,
                     grace_rotation_hour: Optional[float] = None,
                     grace_rotation_interval: Optional[str] = None,
                     item_custom_fields: Optional[Mapping[str, str]] = None,
                     keep_prev_version: Optional[str] = None,
                     key: Optional[str] = None,
                     max_versions: Optional[str] = None,
                     auto_rotate: Optional[str] = None,
                     name: Optional[str] = None,
                     rotation_interval: Optional[str] = None,
                     rotated_secret_aws_id: Optional[str] = None,
                     rotation_event_ins: Optional[Sequence[str]] = None,
                     rotation_hour: Optional[float] = None,
                     rotate_after_disconnect: Optional[str] = None,
                     authentication_credentials: Optional[str] = None,
                     secure_access_aws_account_id: Optional[str] = None,
                     secure_access_aws_native_cli: Optional[bool] = None,
                     password_length: Optional[str] = None,
                     secure_access_enable: 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.

resource "akeyless_rotatedsecretaws" "name" {
    # resource properties
}

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",
    GraceRotation = "string",
    SecureAccessCertificateIssuer = "string",
    AwsRegion = "string",
    DeleteProtection = "string",
    Description = "string",
    ApiId = "string",
    GraceRotationHour = 0,
    GraceRotationInterval = "string",
    ItemCustomFields = 
    {
        { "string", "string" },
    },
    KeepPrevVersion = "string",
    Key = "string",
    MaxVersions = "string",
    AutoRotate = "string",
    Name = "string",
    RotationInterval = "string",
    RotatedSecretAwsId = "string",
    RotationEventIns = new[]
    {
        "string",
    },
    RotationHour = 0,
    RotateAfterDisconnect = "string",
    AuthenticationCredentials = "string",
    SecureAccessAwsAccountId = "string",
    SecureAccessAwsNativeCli = false,
    PasswordLength = "string",
    SecureAccessEnable = "string",
    Tags = new[]
    {
        "string",
    },
    ApiKey = "string",
});

example, err := akeyless.NewRotatedSecretAws(ctx, "rotatedSecretAwsResource", &akeyless.RotatedSecretAwsArgs{
	RotatorType:                   pulumi.String("string"),
	TargetName:                    pulumi.String("string"),
	GraceRotation:                 pulumi.String("string"),
	SecureAccessCertificateIssuer: pulumi.String("string"),
	AwsRegion:                     pulumi.String("string"),
	DeleteProtection:              pulumi.String("string"),
	Description:                   pulumi.String("string"),
	ApiId:                         pulumi.String("string"),
	GraceRotationHour:             pulumi.Float64(0),
	GraceRotationInterval:         pulumi.String("string"),
	ItemCustomFields: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	KeepPrevVersion:    pulumi.String("string"),
	Key:                pulumi.String("string"),
	MaxVersions:        pulumi.String("string"),
	AutoRotate:         pulumi.String("string"),
	Name:               pulumi.String("string"),
	RotationInterval:   pulumi.String("string"),
	RotatedSecretAwsId: pulumi.String("string"),
	RotationEventIns: pulumi.StringArray{
		pulumi.String("string"),
	},
	RotationHour:              pulumi.Float64(0),
	RotateAfterDisconnect:     pulumi.String("string"),
	AuthenticationCredentials: pulumi.String("string"),
	SecureAccessAwsAccountId:  pulumi.String("string"),
	SecureAccessAwsNativeCli:  pulumi.Bool(false),
	PasswordLength:            pulumi.String("string"),
	SecureAccessEnable:        pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	ApiKey: pulumi.String("string"),
})

resource "akeyless_rotatedsecretaws" "rotatedSecretAwsResource" {
  rotator_type                     = "string"
  target_name                      = "string"
  grace_rotation                   = "string"
  secure_access_certificate_issuer = "string"
  aws_region                       = "string"
  delete_protection                = "string"
  description                      = "string"
  api_id                           = "string"
  grace_rotation_hour              = 0
  grace_rotation_interval          = "string"
  item_custom_fields = {
    "string" = "string"
  }
  keep_prev_version            = "string"
  key                          = "string"
  max_versions                 = "string"
  auto_rotate                  = "string"
  name                         = "string"
  rotation_interval            = "string"
  rotated_secret_aws_id        = "string"
  rotation_event_ins           = ["string"]
  rotation_hour                = 0
  rotate_after_disconnect      = "string"
  authentication_credentials   = "string"
  secure_access_aws_account_id = "string"
  secure_access_aws_native_cli = false
  password_length              = "string"
  secure_access_enable         = "string"
  tags                         = ["string"]
  api_key                      = "string"
}

var rotatedSecretAwsResource = new RotatedSecretAws("rotatedSecretAwsResource", RotatedSecretAwsArgs.builder()
    .rotatorType("string")
    .targetName("string")
    .graceRotation("string")
    .secureAccessCertificateIssuer("string")
    .awsRegion("string")
    .deleteProtection("string")
    .description("string")
    .apiId("string")
    .graceRotationHour(0.0)
    .graceRotationInterval("string")
    .itemCustomFields(Map.of("string", "string"))
    .keepPrevVersion("string")
    .key("string")
    .maxVersions("string")
    .autoRotate("string")
    .name("string")
    .rotationInterval("string")
    .rotatedSecretAwsId("string")
    .rotationEventIns("string")
    .rotationHour(0.0)
    .rotateAfterDisconnect("string")
    .authenticationCredentials("string")
    .secureAccessAwsAccountId("string")
    .secureAccessAwsNativeCli(false)
    .passwordLength("string")
    .secureAccessEnable("string")
    .tags("string")
    .apiKey("string")
    .build());

rotated_secret_aws_resource = akeyless.RotatedSecretAws("rotatedSecretAwsResource",
    rotator_type="string",
    target_name="string",
    grace_rotation="string",
    secure_access_certificate_issuer="string",
    aws_region="string",
    delete_protection="string",
    description="string",
    api_id="string",
    grace_rotation_hour=float(0),
    grace_rotation_interval="string",
    item_custom_fields={
        "string": "string",
    },
    keep_prev_version="string",
    key="string",
    max_versions="string",
    auto_rotate="string",
    name="string",
    rotation_interval="string",
    rotated_secret_aws_id="string",
    rotation_event_ins=["string"],
    rotation_hour=float(0),
    rotate_after_disconnect="string",
    authentication_credentials="string",
    secure_access_aws_account_id="string",
    secure_access_aws_native_cli=False,
    password_length="string",
    secure_access_enable="string",
    tags=["string"],
    api_key="string")

const rotatedSecretAwsResource = new akeyless.RotatedSecretAws("rotatedSecretAwsResource", {
    rotatorType: "string",
    targetName: "string",
    graceRotation: "string",
    secureAccessCertificateIssuer: "string",
    awsRegion: "string",
    deleteProtection: "string",
    description: "string",
    apiId: "string",
    graceRotationHour: 0,
    graceRotationInterval: "string",
    itemCustomFields: {
        string: "string",
    },
    keepPrevVersion: "string",
    key: "string",
    maxVersions: "string",
    autoRotate: "string",
    name: "string",
    rotationInterval: "string",
    rotatedSecretAwsId: "string",
    rotationEventIns: ["string"],
    rotationHour: 0,
    rotateAfterDisconnect: "string",
    authenticationCredentials: "string",
    secureAccessAwsAccountId: "string",
    secureAccessAwsNativeCli: false,
    passwordLength: "string",
    secureAccessEnable: "string",
    tags: ["string"],
    apiKey: "string",
});

type: akeyless:RotatedSecretAws
properties:
    apiId: string
    apiKey: string
    authenticationCredentials: string
    autoRotate: string
    awsRegion: string
    deleteProtection: string
    description: string
    graceRotation: string
    graceRotationHour: 0
    graceRotationInterval: string
    itemCustomFields:
        string: string
    keepPrevVersion: string
    key: string
    maxVersions: string
    name: string
    passwordLength: string
    rotateAfterDisconnect: string
    rotatedSecretAwsId: string
    rotationEventIns:
        - string
    rotationHour: 0
    rotationInterval: string
    rotatorType: string
    secureAccessAwsAccountId: string
    secureAccessAwsNativeCli: false
    secureAccessCertificateIssuer: string
    secureAccessEnable: 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. options: [target/api-key]
TargetName string: Target name
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 [true/false]
AwsRegion string: Aws Region
DeleteProtection string: Protection from accidental deletion of this object [true/false]
Description string: Description of the object
GraceRotation string: Create a new access key without deleting the old key from AWS/Azure/GCP for backup (relevant only for AWS/Azure/GCP) [true/false]
GraceRotationHour double: The Hour of the grace rotation in UTC
GraceRotationInterval string: The number of days to wait before deleting the old key (must be bigger than rotation-interval)
ItemCustomFields Dictionary<string, string>: Additional custom fields to associate with the item
KeepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
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)
MaxVersions string: Set the maximum number of versions, limited by the account settings defaults.
Name string: Rotated secret name
PasswordLength string: The length of the password to be generated
RotateAfterDisconnect string: Rotate the value of the secret after SRA session ends [true/false]
RotatedSecretAwsId string: The ID of this resource.
RotationEventIns List<string>: How many days before the rotation of the item would you like to be notified
RotationHour double: The Hour of the rotation in UTC
RotationInterval string: The number of days to wait between every automatic key rotation (1-365)
SecureAccessAwsAccountId string: The AWS account id
SecureAccessAwsNativeCli bool: The AWS native cli
SecureAccessCertificateIssuer string: Path to the SSH Certificate Issuer for your Akeyless Secure Access
SecureAccessEnable string: Enable/Disable secure remote access [true/false]
Tags List<string>: Add tags attached to this object

RotatorType string: The rotator type. options: [target/api-key]
TargetName string: Target name
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 [true/false]
AwsRegion string: Aws Region
DeleteProtection string: Protection from accidental deletion of this object [true/false]
Description string: Description of the object
GraceRotation string: Create a new access key without deleting the old key from AWS/Azure/GCP for backup (relevant only for AWS/Azure/GCP) [true/false]
GraceRotationHour float64: The Hour of the grace rotation in UTC
GraceRotationInterval string: The number of days to wait before deleting the old key (must be bigger than rotation-interval)
ItemCustomFields map[string]string: Additional custom fields to associate with the item
KeepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
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)
MaxVersions string: Set the maximum number of versions, limited by the account settings defaults.
Name string: Rotated secret name
PasswordLength string: The length of the password to be generated
RotateAfterDisconnect string: Rotate the value of the secret after SRA session ends [true/false]
RotatedSecretAwsId string: The ID of this resource.
RotationEventIns []string: How many days before the rotation of the item would you like to be notified
RotationHour float64: The Hour of the rotation in UTC
RotationInterval string: The number of days to wait between every automatic key rotation (1-365)
SecureAccessAwsAccountId string: The AWS account id
SecureAccessAwsNativeCli bool: The AWS native cli
SecureAccessCertificateIssuer string: Path to the SSH Certificate Issuer for your Akeyless Secure Access
SecureAccessEnable string: Enable/Disable secure remote access [true/false]
Tags []string: Add tags attached to this object

rotator_type string: The rotator type. options: [target/api-key]
target_name string: Target name
api_id string: API ID to rotate (relevant only for rotator-type=api-key)
api_key string: API key to rotate (relevant only for rotator-type=api-key)
authentication_credentials string: The credentials to connect with use-self-creds/use-target-creds
auto_rotate string: Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation [true/false]
aws_region string: Aws Region
delete_protection string: Protection from accidental deletion of this object [true/false]
description string: Description of the object
grace_rotation string: Create a new access key without deleting the old key from AWS/Azure/GCP for backup (relevant only for AWS/Azure/GCP) [true/false]
grace_rotation_hour number: The Hour of the grace rotation in UTC
grace_rotation_interval string: The number of days to wait before deleting the old key (must be bigger than rotation-interval)
item_custom_fields map(string): Additional custom fields to associate with the item
keep_prev_version string: Whether to keep previous version [true/false]. If not set, use default according to account settings
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)
max_versions string: Set the maximum number of versions, limited by the account settings defaults.
name string: Rotated secret name
password_length string: The length of the password to be generated
rotate_after_disconnect string: Rotate the value of the secret after SRA session ends [true/false]
rotated_secret_aws_id string: The ID of this resource.
rotation_event_ins list(string): How many days before the rotation of the item would you like to be notified
rotation_hour number: The Hour of the rotation in UTC
rotation_interval string: The number of days to wait between every automatic key rotation (1-365)
secure_access_aws_account_id string: The AWS account id
secure_access_aws_native_cli bool: The AWS native cli
secure_access_certificate_issuer string: Path to the SSH Certificate Issuer for your Akeyless Secure Access
secure_access_enable string: Enable/Disable secure remote access [true/false]
tags list(string): Add tags attached to this object

rotatorType String: The rotator type. options: [target/api-key]
targetName String: Target name
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 [true/false]
awsRegion String: Aws Region
deleteProtection String: Protection from accidental deletion of this object [true/false]
description String: Description of the object
graceRotation String: Create a new access key without deleting the old key from AWS/Azure/GCP for backup (relevant only for AWS/Azure/GCP) [true/false]
graceRotationHour Double: The Hour of the grace rotation in UTC
graceRotationInterval String: The number of days to wait before deleting the old key (must be bigger than rotation-interval)
itemCustomFields Map<String,String>: Additional custom fields to associate with the item
keepPrevVersion String: Whether to keep previous version [true/false]. If not set, use default according to account settings
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)
maxVersions String: Set the maximum number of versions, limited by the account settings defaults.
name String: Rotated secret name
passwordLength String: The length of the password to be generated
rotateAfterDisconnect String: Rotate the value of the secret after SRA session ends [true/false]
rotatedSecretAwsId String: The ID of this resource.
rotationEventIns List<String>: How many days before the rotation of the item would you like to be notified
rotationHour Double: The Hour of the rotation in UTC
rotationInterval String: The number of days to wait between every automatic key rotation (1-365)
secureAccessAwsAccountId String: The AWS account id
secureAccessAwsNativeCli Boolean: The AWS native cli
secureAccessCertificateIssuer String: Path to the SSH Certificate Issuer for your Akeyless Secure Access
secureAccessEnable String: Enable/Disable secure remote access [true/false]
tags List<String>: Add tags attached to this object

rotatorType string: The rotator type. options: [target/api-key]
targetName string: Target name
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 [true/false]
awsRegion string: Aws Region
deleteProtection string: Protection from accidental deletion of this object [true/false]
description string: Description of the object
graceRotation string: Create a new access key without deleting the old key from AWS/Azure/GCP for backup (relevant only for AWS/Azure/GCP) [true/false]
graceRotationHour number: The Hour of the grace rotation in UTC
graceRotationInterval string: The number of days to wait before deleting the old key (must be bigger than rotation-interval)
itemCustomFields {[key: string]: string}: Additional custom fields to associate with the item
keepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
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)
maxVersions string: Set the maximum number of versions, limited by the account settings defaults.
name string: Rotated secret name
passwordLength string: The length of the password to be generated
rotateAfterDisconnect string: Rotate the value of the secret after SRA session ends [true/false]
rotatedSecretAwsId string: The ID of this resource.
rotationEventIns string[]: How many days before the rotation of the item would you like to be notified
rotationHour number: The Hour of the rotation in UTC
rotationInterval string: The number of days to wait between every automatic key rotation (1-365)
secureAccessAwsAccountId string: The AWS account id
secureAccessAwsNativeCli boolean: The AWS native cli
secureAccessCertificateIssuer string: Path to the SSH Certificate Issuer for your Akeyless Secure Access
secureAccessEnable string: Enable/Disable secure remote access [true/false]
tags string[]: Add tags attached to this object

rotator_type str: The rotator type. options: [target/api-key]
target_name str: Target name
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 [true/false]
aws_region str: Aws Region
delete_protection str: Protection from accidental deletion of this object [true/false]
description str: Description of the object
grace_rotation str: Create a new access key without deleting the old key from AWS/Azure/GCP for backup (relevant only for AWS/Azure/GCP) [true/false]
grace_rotation_hour float: The Hour of the grace rotation in UTC
grace_rotation_interval str: The number of days to wait before deleting the old key (must be bigger than rotation-interval)
item_custom_fields Mapping[str, str]: Additional custom fields to associate with the item
keep_prev_version str: Whether to keep previous version [true/false]. If not set, use default according to account settings
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)
max_versions str: Set the maximum number of versions, limited by the account settings defaults.
name str: Rotated secret name
password_length str: The length of the password to be generated
rotate_after_disconnect str: Rotate the value of the secret after SRA session ends [true/false]
rotated_secret_aws_id str: The ID of this resource.
rotation_event_ins Sequence[str]: How many days before the rotation of the item would you like to be notified
rotation_hour float: The Hour of the rotation in UTC
rotation_interval str: The number of days to wait between every automatic key rotation (1-365)
secure_access_aws_account_id str: The AWS account id
secure_access_aws_native_cli bool: The AWS native cli
secure_access_certificate_issuer str: Path to the SSH Certificate Issuer for your Akeyless Secure Access
secure_access_enable str: Enable/Disable secure remote access [true/false]
tags Sequence[str]: Add tags attached to this object

rotatorType String: The rotator type. options: [target/api-key]
targetName String: Target name
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 [true/false]
awsRegion String: Aws Region
deleteProtection String: Protection from accidental deletion of this object [true/false]
description String: Description of the object
graceRotation String: Create a new access key without deleting the old key from AWS/Azure/GCP for backup (relevant only for AWS/Azure/GCP) [true/false]
graceRotationHour Number: The Hour of the grace rotation in UTC
graceRotationInterval String: The number of days to wait before deleting the old key (must be bigger than rotation-interval)
itemCustomFields Map<String>: Additional custom fields to associate with the item
keepPrevVersion String: Whether to keep previous version [true/false]. If not set, use default according to account settings
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)
maxVersions String: Set the maximum number of versions, limited by the account settings defaults.
name String: Rotated secret name
passwordLength String: The length of the password to be generated
rotateAfterDisconnect String: Rotate the value of the secret after SRA session ends [true/false]
rotatedSecretAwsId String: The ID of this resource.
rotationEventIns List<String>: How many days before the rotation of the item would you like to be notified
rotationHour Number: The Hour of the rotation in UTC
rotationInterval String: The number of days to wait between every automatic key rotation (1-365)
secureAccessAwsAccountId String: The AWS account id
secureAccessAwsNativeCli Boolean: The AWS native cli
secureAccessCertificateIssuer String: Path to the SSH Certificate Issuer for your Akeyless Secure Access
secureAccessEnable String: Enable/Disable secure remote access [true/false]
tags List<String>: Add tags attached to this object

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 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,
        aws_region: Optional[str] = None,
        delete_protection: Optional[str] = None,
        description: Optional[str] = None,
        grace_rotation: Optional[str] = None,
        grace_rotation_hour: Optional[float] = None,
        grace_rotation_interval: Optional[str] = None,
        item_custom_fields: Optional[Mapping[str, str]] = None,
        keep_prev_version: Optional[str] = None,
        key: Optional[str] = None,
        max_versions: Optional[str] = None,
        name: Optional[str] = None,
        password_length: Optional[str] = None,
        rotate_after_disconnect: Optional[str] = None,
        rotated_secret_aws_id: Optional[str] = None,
        rotation_event_ins: Optional[Sequence[str]] = None,
        rotation_hour: Optional[float] = None,
        rotation_interval: Optional[str] = None,
        rotator_type: Optional[str] = None,
        secure_access_aws_account_id: Optional[str] = None,
        secure_access_aws_native_cli: Optional[bool] = None,
        secure_access_certificate_issuer: Optional[str] = None,
        secure_access_enable: 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}

import {
  to = akeyless_rotatedsecretaws.example
  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 [true/false]
AwsRegion string: Aws Region
DeleteProtection string: Protection from accidental deletion of this object [true/false]
Description string: Description of the object
GraceRotation string: Create a new access key without deleting the old key from AWS/Azure/GCP for backup (relevant only for AWS/Azure/GCP) [true/false]
GraceRotationHour double: The Hour of the grace rotation in UTC
GraceRotationInterval string: The number of days to wait before deleting the old key (must be bigger than rotation-interval)
ItemCustomFields Dictionary<string, string>: Additional custom fields to associate with the item
KeepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
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)
MaxVersions string: Set the maximum number of versions, limited by the account settings defaults.
Name string: Rotated secret name
PasswordLength string: The length of the password to be generated
RotateAfterDisconnect string: Rotate the value of the secret after SRA session ends [true/false]
RotatedSecretAwsId string: The ID of this resource.
RotationEventIns List<string>: How many days before the rotation of the item would you like to be notified
RotationHour double: The Hour of the rotation in UTC
RotationInterval string: The number of days to wait between every automatic key rotation (1-365)
RotatorType string: The rotator type. options: [target/api-key]
SecureAccessAwsAccountId string: The AWS account id
SecureAccessAwsNativeCli bool: The AWS native cli
SecureAccessCertificateIssuer string: Path to the SSH Certificate Issuer for your Akeyless Secure Access
SecureAccessEnable string: Enable/Disable secure remote access [true/false]
Tags List<string>: Add tags attached to this object
TargetName string: Target name

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 [true/false]
AwsRegion string: Aws Region
DeleteProtection string: Protection from accidental deletion of this object [true/false]
Description string: Description of the object
GraceRotation string: Create a new access key without deleting the old key from AWS/Azure/GCP for backup (relevant only for AWS/Azure/GCP) [true/false]
GraceRotationHour float64: The Hour of the grace rotation in UTC
GraceRotationInterval string: The number of days to wait before deleting the old key (must be bigger than rotation-interval)
ItemCustomFields map[string]string: Additional custom fields to associate with the item
KeepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
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)
MaxVersions string: Set the maximum number of versions, limited by the account settings defaults.
Name string: Rotated secret name
PasswordLength string: The length of the password to be generated
RotateAfterDisconnect string: Rotate the value of the secret after SRA session ends [true/false]
RotatedSecretAwsId string: The ID of this resource.
RotationEventIns []string: How many days before the rotation of the item would you like to be notified
RotationHour float64: The Hour of the rotation in UTC
RotationInterval string: The number of days to wait between every automatic key rotation (1-365)
RotatorType string: The rotator type. options: [target/api-key]
SecureAccessAwsAccountId string: The AWS account id
SecureAccessAwsNativeCli bool: The AWS native cli
SecureAccessCertificateIssuer string: Path to the SSH Certificate Issuer for your Akeyless Secure Access
SecureAccessEnable string: Enable/Disable secure remote access [true/false]
Tags []string: Add tags attached to this object
TargetName string: Target name

api_id string: API ID to rotate (relevant only for rotator-type=api-key)
api_key string: API key to rotate (relevant only for rotator-type=api-key)
authentication_credentials string: The credentials to connect with use-self-creds/use-target-creds
auto_rotate string: Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation [true/false]
aws_region string: Aws Region
delete_protection string: Protection from accidental deletion of this object [true/false]
description string: Description of the object
grace_rotation string: Create a new access key without deleting the old key from AWS/Azure/GCP for backup (relevant only for AWS/Azure/GCP) [true/false]
grace_rotation_hour number: The Hour of the grace rotation in UTC
grace_rotation_interval string: The number of days to wait before deleting the old key (must be bigger than rotation-interval)
item_custom_fields map(string): Additional custom fields to associate with the item
keep_prev_version string: Whether to keep previous version [true/false]. If not set, use default according to account settings
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)
max_versions string: Set the maximum number of versions, limited by the account settings defaults.
name string: Rotated secret name
password_length string: The length of the password to be generated
rotate_after_disconnect string: Rotate the value of the secret after SRA session ends [true/false]
rotated_secret_aws_id string: The ID of this resource.
rotation_event_ins list(string): How many days before the rotation of the item would you like to be notified
rotation_hour number: The Hour of the rotation in UTC
rotation_interval string: The number of days to wait between every automatic key rotation (1-365)
rotator_type string: The rotator type. options: [target/api-key]
secure_access_aws_account_id string: The AWS account id
secure_access_aws_native_cli bool: The AWS native cli
secure_access_certificate_issuer string: Path to the SSH Certificate Issuer for your Akeyless Secure Access
secure_access_enable string: Enable/Disable secure remote access [true/false]
tags list(string): Add tags attached to this object
target_name string: Target name

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 [true/false]
awsRegion String: Aws Region
deleteProtection String: Protection from accidental deletion of this object [true/false]
description String: Description of the object
graceRotation String: Create a new access key without deleting the old key from AWS/Azure/GCP for backup (relevant only for AWS/Azure/GCP) [true/false]
graceRotationHour Double: The Hour of the grace rotation in UTC
graceRotationInterval String: The number of days to wait before deleting the old key (must be bigger than rotation-interval)
itemCustomFields Map<String,String>: Additional custom fields to associate with the item
keepPrevVersion String: Whether to keep previous version [true/false]. If not set, use default according to account settings
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)
maxVersions String: Set the maximum number of versions, limited by the account settings defaults.
name String: Rotated secret name
passwordLength String: The length of the password to be generated
rotateAfterDisconnect String: Rotate the value of the secret after SRA session ends [true/false]
rotatedSecretAwsId String: The ID of this resource.
rotationEventIns List<String>: How many days before the rotation of the item would you like to be notified
rotationHour Double: The Hour of the rotation in UTC
rotationInterval String: The number of days to wait between every automatic key rotation (1-365)
rotatorType String: The rotator type. options: [target/api-key]
secureAccessAwsAccountId String: The AWS account id
secureAccessAwsNativeCli Boolean: The AWS native cli
secureAccessCertificateIssuer String: Path to the SSH Certificate Issuer for your Akeyless Secure Access
secureAccessEnable String: Enable/Disable secure remote access [true/false]
tags List<String>: Add tags attached to this object
targetName String: Target name

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 [true/false]
awsRegion string: Aws Region
deleteProtection string: Protection from accidental deletion of this object [true/false]
description string: Description of the object
graceRotation string: Create a new access key without deleting the old key from AWS/Azure/GCP for backup (relevant only for AWS/Azure/GCP) [true/false]
graceRotationHour number: The Hour of the grace rotation in UTC
graceRotationInterval string: The number of days to wait before deleting the old key (must be bigger than rotation-interval)
itemCustomFields {[key: string]: string}: Additional custom fields to associate with the item
keepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
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)
maxVersions string: Set the maximum number of versions, limited by the account settings defaults.
name string: Rotated secret name
passwordLength string: The length of the password to be generated
rotateAfterDisconnect string: Rotate the value of the secret after SRA session ends [true/false]
rotatedSecretAwsId string: The ID of this resource.
rotationEventIns string[]: How many days before the rotation of the item would you like to be notified
rotationHour number: The Hour of the rotation in UTC
rotationInterval string: The number of days to wait between every automatic key rotation (1-365)
rotatorType string: The rotator type. options: [target/api-key]
secureAccessAwsAccountId string: The AWS account id
secureAccessAwsNativeCli boolean: The AWS native cli
secureAccessCertificateIssuer string: Path to the SSH Certificate Issuer for your Akeyless Secure Access
secureAccessEnable string: Enable/Disable secure remote access [true/false]
tags string[]: Add tags attached to this object
targetName string: Target name

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 [true/false]
aws_region str: Aws Region
delete_protection str: Protection from accidental deletion of this object [true/false]
description str: Description of the object
grace_rotation str: Create a new access key without deleting the old key from AWS/Azure/GCP for backup (relevant only for AWS/Azure/GCP) [true/false]
grace_rotation_hour float: The Hour of the grace rotation in UTC
grace_rotation_interval str: The number of days to wait before deleting the old key (must be bigger than rotation-interval)
item_custom_fields Mapping[str, str]: Additional custom fields to associate with the item
keep_prev_version str: Whether to keep previous version [true/false]. If not set, use default according to account settings
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)
max_versions str: Set the maximum number of versions, limited by the account settings defaults.
name str: Rotated secret name
password_length str: The length of the password to be generated
rotate_after_disconnect str: Rotate the value of the secret after SRA session ends [true/false]
rotated_secret_aws_id str: The ID of this resource.
rotation_event_ins Sequence[str]: How many days before the rotation of the item would you like to be notified
rotation_hour float: The Hour of the rotation in UTC
rotation_interval str: The number of days to wait between every automatic key rotation (1-365)
rotator_type str: The rotator type. options: [target/api-key]
secure_access_aws_account_id str: The AWS account id
secure_access_aws_native_cli bool: The AWS native cli
secure_access_certificate_issuer str: Path to the SSH Certificate Issuer for your Akeyless Secure Access
secure_access_enable str: Enable/Disable secure remote access [true/false]
tags Sequence[str]: Add tags attached to this object
target_name str: Target name

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 [true/false]
awsRegion String: Aws Region
deleteProtection String: Protection from accidental deletion of this object [true/false]
description String: Description of the object
graceRotation String: Create a new access key without deleting the old key from AWS/Azure/GCP for backup (relevant only for AWS/Azure/GCP) [true/false]
graceRotationHour Number: The Hour of the grace rotation in UTC
graceRotationInterval String: The number of days to wait before deleting the old key (must be bigger than rotation-interval)
itemCustomFields Map<String>: Additional custom fields to associate with the item
keepPrevVersion String: Whether to keep previous version [true/false]. If not set, use default according to account settings
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)
maxVersions String: Set the maximum number of versions, limited by the account settings defaults.
name String: Rotated secret name
passwordLength String: The length of the password to be generated
rotateAfterDisconnect String: Rotate the value of the secret after SRA session ends [true/false]
rotatedSecretAwsId String: The ID of this resource.
rotationEventIns List<String>: How many days before the rotation of the item would you like to be notified
rotationHour Number: The Hour of the rotation in UTC
rotationInterval String: The number of days to wait between every automatic key rotation (1-365)
rotatorType String: The rotator type. options: [target/api-key]
secureAccessAwsAccountId String: The AWS account id
secureAccessAwsNativeCli Boolean: The AWS native cli
secureAccessCertificateIssuer String: Path to the SSH Certificate Issuer for your Akeyless Secure Access
secureAccessEnable String: Enable/Disable secure remote access [true/false]
tags List<String>: Add tags attached to this object
targetName String: Target name