DynamicSecretAws

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 DynamicSecretAws Resource

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

Constructor syntax

new DynamicSecretAws(name: string, args?: DynamicSecretAwsArgs, opts?: CustomResourceOptions);

@overload
def DynamicSecretAws(resource_name: str,
                     args: Optional[DynamicSecretAwsArgs] = None,
                     opts: Optional[ResourceOptions] = None)

@overload
def DynamicSecretAws(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     access_mode: Optional[str] = None,
                     admin_rotation_interval_days: Optional[float] = None,
                     aws_access_key_id: Optional[str] = None,
                     aws_access_secret_key: Optional[str] = None,
                     aws_external_id: Optional[str] = None,
                     aws_role_arns: Optional[str] = None,
                     aws_user_console_access: Optional[bool] = None,
                     aws_user_groups: Optional[str] = None,
                     aws_user_policies: Optional[str] = None,
                     aws_user_programmatic_access: Optional[bool] = None,
                     custom_username_template: Optional[str] = None,
                     delete_protection: Optional[str] = None,
                     description: Optional[str] = None,
                     dynamic_secret_aws_id: Optional[str] = None,
                     enable_admin_rotation: Optional[bool] = None,
                     encryption_key_name: Optional[str] = None,
                     item_custom_fields: Optional[Mapping[str, str]] = None,
                     name: Optional[str] = None,
                     password_length: Optional[str] = None,
                     region: Optional[str] = None,
                     secure_access_aws_account_id: Optional[str] = None,
                     secure_access_aws_native_cli: Optional[bool] = None,
                     secure_access_aws_region: Optional[str] = None,
                     secure_access_bastion_issuer: Optional[str] = None,
                     secure_access_certificate_issuer: Optional[str] = None,
                     secure_access_delay: Optional[float] = None,
                     secure_access_enable: Optional[str] = None,
                     secure_access_url: Optional[str] = None,
                     secure_access_web: Optional[bool] = None,
                     secure_access_web_browsing: Optional[bool] = None,
                     secure_access_web_proxy: Optional[bool] = None,
                     session_tags: Optional[str] = None,
                     tags: Optional[Sequence[str]] = None,
                     target_name: Optional[str] = None,
                     transitive_tag_keys: Optional[str] = None,
                     user_ttl: Optional[str] = None)

func NewDynamicSecretAws(ctx *Context, name string, args *DynamicSecretAwsArgs, opts ...ResourceOption) (*DynamicSecretAws, error)

public DynamicSecretAws(string name, DynamicSecretAwsArgs? args = null, CustomResourceOptions? opts = null)

public DynamicSecretAws(String name, DynamicSecretAwsArgs args)
public DynamicSecretAws(String name, DynamicSecretAwsArgs args, CustomResourceOptions options)

type: akeyless:DynamicSecretAws
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 DynamicSecretAwsArgs: 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 DynamicSecretAwsArgs: 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 DynamicSecretAwsArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DynamicSecretAwsArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DynamicSecretAwsArgs: 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 dynamicSecretAwsResource = new Akeyless.DynamicSecretAws("dynamicSecretAwsResource", new()
{
    AccessMode = "string",
    AdminRotationIntervalDays = 0,
    AwsAccessKeyId = "string",
    AwsAccessSecretKey = "string",
    AwsExternalId = "string",
    AwsRoleArns = "string",
    AwsUserConsoleAccess = false,
    AwsUserGroups = "string",
    AwsUserPolicies = "string",
    AwsUserProgrammaticAccess = false,
    CustomUsernameTemplate = "string",
    DeleteProtection = "string",
    Description = "string",
    DynamicSecretAwsId = "string",
    EnableAdminRotation = false,
    EncryptionKeyName = "string",
    ItemCustomFields = 
    {
        { "string", "string" },
    },
    Name = "string",
    PasswordLength = "string",
    Region = "string",
    SecureAccessAwsAccountId = "string",
    SecureAccessAwsNativeCli = false,
    SecureAccessAwsRegion = "string",
    SecureAccessCertificateIssuer = "string",
    SecureAccessDelay = 0,
    SecureAccessEnable = "string",
    SecureAccessUrl = "string",
    SecureAccessWeb = false,
    SecureAccessWebBrowsing = false,
    SecureAccessWebProxy = false,
    SessionTags = "string",
    Tags = new[]
    {
        "string",
    },
    TargetName = "string",
    TransitiveTagKeys = "string",
    UserTtl = "string",
});

example, err := akeyless.NewDynamicSecretAws(ctx, "dynamicSecretAwsResource", &akeyless.DynamicSecretAwsArgs{
	AccessMode:                pulumi.String("string"),
	AdminRotationIntervalDays: pulumi.Float64(0),
	AwsAccessKeyId:            pulumi.String("string"),
	AwsAccessSecretKey:        pulumi.String("string"),
	AwsExternalId:             pulumi.String("string"),
	AwsRoleArns:               pulumi.String("string"),
	AwsUserConsoleAccess:      pulumi.Bool(false),
	AwsUserGroups:             pulumi.String("string"),
	AwsUserPolicies:           pulumi.String("string"),
	AwsUserProgrammaticAccess: pulumi.Bool(false),
	CustomUsernameTemplate:    pulumi.String("string"),
	DeleteProtection:          pulumi.String("string"),
	Description:               pulumi.String("string"),
	DynamicSecretAwsId:        pulumi.String("string"),
	EnableAdminRotation:       pulumi.Bool(false),
	EncryptionKeyName:         pulumi.String("string"),
	ItemCustomFields: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:                          pulumi.String("string"),
	PasswordLength:                pulumi.String("string"),
	Region:                        pulumi.String("string"),
	SecureAccessAwsAccountId:      pulumi.String("string"),
	SecureAccessAwsNativeCli:      pulumi.Bool(false),
	SecureAccessAwsRegion:         pulumi.String("string"),
	SecureAccessCertificateIssuer: pulumi.String("string"),
	SecureAccessDelay:             pulumi.Float64(0),
	SecureAccessEnable:            pulumi.String("string"),
	SecureAccessUrl:               pulumi.String("string"),
	SecureAccessWeb:               pulumi.Bool(false),
	SecureAccessWebBrowsing:       pulumi.Bool(false),
	SecureAccessWebProxy:          pulumi.Bool(false),
	SessionTags:                   pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	TargetName:        pulumi.String("string"),
	TransitiveTagKeys: pulumi.String("string"),
	UserTtl:           pulumi.String("string"),
})

var dynamicSecretAwsResource = new DynamicSecretAws("dynamicSecretAwsResource", DynamicSecretAwsArgs.builder()
    .accessMode("string")
    .adminRotationIntervalDays(0.0)
    .awsAccessKeyId("string")
    .awsAccessSecretKey("string")
    .awsExternalId("string")
    .awsRoleArns("string")
    .awsUserConsoleAccess(false)
    .awsUserGroups("string")
    .awsUserPolicies("string")
    .awsUserProgrammaticAccess(false)
    .customUsernameTemplate("string")
    .deleteProtection("string")
    .description("string")
    .dynamicSecretAwsId("string")
    .enableAdminRotation(false)
    .encryptionKeyName("string")
    .itemCustomFields(Map.of("string", "string"))
    .name("string")
    .passwordLength("string")
    .region("string")
    .secureAccessAwsAccountId("string")
    .secureAccessAwsNativeCli(false)
    .secureAccessAwsRegion("string")
    .secureAccessCertificateIssuer("string")
    .secureAccessDelay(0.0)
    .secureAccessEnable("string")
    .secureAccessUrl("string")
    .secureAccessWeb(false)
    .secureAccessWebBrowsing(false)
    .secureAccessWebProxy(false)
    .sessionTags("string")
    .tags("string")
    .targetName("string")
    .transitiveTagKeys("string")
    .userTtl("string")
    .build());

dynamic_secret_aws_resource = akeyless.DynamicSecretAws("dynamicSecretAwsResource",
    access_mode="string",
    admin_rotation_interval_days=float(0),
    aws_access_key_id="string",
    aws_access_secret_key="string",
    aws_external_id="string",
    aws_role_arns="string",
    aws_user_console_access=False,
    aws_user_groups="string",
    aws_user_policies="string",
    aws_user_programmatic_access=False,
    custom_username_template="string",
    delete_protection="string",
    description="string",
    dynamic_secret_aws_id="string",
    enable_admin_rotation=False,
    encryption_key_name="string",
    item_custom_fields={
        "string": "string",
    },
    name="string",
    password_length="string",
    region="string",
    secure_access_aws_account_id="string",
    secure_access_aws_native_cli=False,
    secure_access_aws_region="string",
    secure_access_certificate_issuer="string",
    secure_access_delay=float(0),
    secure_access_enable="string",
    secure_access_url="string",
    secure_access_web=False,
    secure_access_web_browsing=False,
    secure_access_web_proxy=False,
    session_tags="string",
    tags=["string"],
    target_name="string",
    transitive_tag_keys="string",
    user_ttl="string")

const dynamicSecretAwsResource = new akeyless.DynamicSecretAws("dynamicSecretAwsResource", {
    accessMode: "string",
    adminRotationIntervalDays: 0,
    awsAccessKeyId: "string",
    awsAccessSecretKey: "string",
    awsExternalId: "string",
    awsRoleArns: "string",
    awsUserConsoleAccess: false,
    awsUserGroups: "string",
    awsUserPolicies: "string",
    awsUserProgrammaticAccess: false,
    customUsernameTemplate: "string",
    deleteProtection: "string",
    description: "string",
    dynamicSecretAwsId: "string",
    enableAdminRotation: false,
    encryptionKeyName: "string",
    itemCustomFields: {
        string: "string",
    },
    name: "string",
    passwordLength: "string",
    region: "string",
    secureAccessAwsAccountId: "string",
    secureAccessAwsNativeCli: false,
    secureAccessAwsRegion: "string",
    secureAccessCertificateIssuer: "string",
    secureAccessDelay: 0,
    secureAccessEnable: "string",
    secureAccessUrl: "string",
    secureAccessWeb: false,
    secureAccessWebBrowsing: false,
    secureAccessWebProxy: false,
    sessionTags: "string",
    tags: ["string"],
    targetName: "string",
    transitiveTagKeys: "string",
    userTtl: "string",
});

type: akeyless:DynamicSecretAws
properties:
    accessMode: string
    adminRotationIntervalDays: 0
    awsAccessKeyId: string
    awsAccessSecretKey: string
    awsExternalId: string
    awsRoleArns: string
    awsUserConsoleAccess: false
    awsUserGroups: string
    awsUserPolicies: string
    awsUserProgrammaticAccess: false
    customUsernameTemplate: string
    deleteProtection: string
    description: string
    dynamicSecretAwsId: string
    enableAdminRotation: false
    encryptionKeyName: string
    itemCustomFields:
        string: string
    name: string
    passwordLength: string
    region: string
    secureAccessAwsAccountId: string
    secureAccessAwsNativeCli: false
    secureAccessAwsRegion: string
    secureAccessCertificateIssuer: string
    secureAccessDelay: 0
    secureAccessEnable: string
    secureAccessUrl: string
    secureAccessWeb: false
    secureAccessWebBrowsing: false
    secureAccessWebProxy: false
    sessionTags: string
    tags:
        - string
    targetName: string
    transitiveTagKeys: string
    userTtl: string

DynamicSecretAws 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 DynamicSecretAws resource accepts the following input properties:

AccessMode string: The types of credentials to retrieve from AWS. Options:[iamuser,assumerole]
AdminRotationIntervalDays double: Admin credentials rotation interval (days)
AwsAccessKeyId string: Access Key ID
AwsAccessSecretKey string: Access Secret Key
AwsExternalId string: The AWS External ID associated with the AWS role (relevant only for assume_role mode)
AwsRoleArns string: AWS Role ARNs to be use in the Assume Role operation. Multiple values should be separated by comma
AwsUserConsoleAccess bool: Enable AWS User console access
AwsUserGroups string: UserGroup name(s). Multiple values should be separated by comma
AwsUserPolicies string: Policy ARN(s). Multiple values should be separated by comma
AwsUserProgrammaticAccess bool: Enable AWS User programmatic access
CustomUsernameTemplate string: Customize how temporary usernames are generated using go template
DeleteProtection string: Protection from accidental deletion of this object [true/false]
Description string: Description of the object
DynamicSecretAwsId string: The ID of this resource.
EnableAdminRotation bool: Automatic admin credentials rotation
EncryptionKeyName string: Encrypt dynamic secret details with following key
ItemCustomFields Dictionary<string, string>: Additional custom fields to associate with the item
Name string: Dynamic secret name
PasswordLength string: The length of the password to be generated
Region string: Region
SecureAccessAwsAccountId string: The aws account id
SecureAccessAwsNativeCli bool: The aws native cli
SecureAccessAwsRegion string
SecureAccessBastionIssuer string: Path to the SSH Certificate Issuer for your Akeyless Bastion
Deprecated: Deprecated
SecureAccessCertificateIssuer string: Path to the SSH Certificate Issuer for your Akeyless Secure Access
SecureAccessDelay double: The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
SecureAccessEnable string: Enable/Disable secure remote access, [true/false]
SecureAccessUrl string
SecureAccessWeb bool: Enable Web Secure Remote Access
SecureAccessWebBrowsing bool: Secure browser via Akeyless Web Access Bastion
SecureAccessWebProxy bool: Web-Proxy via Akeyless's Secure Remote Access (SRA)
SessionTags string: Session tags, space separated, relevant only for Assumed Role. Format: Key=name,Value=val Key=name2,Value=val2
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: Name of existing target to use in dynamic secret creation
TransitiveTagKeys string: Transitive tag keys, space separated, relevant only for Assumed Role
UserTtl string: User TTL

AccessMode string: The types of credentials to retrieve from AWS. Options:[iamuser,assumerole]
AdminRotationIntervalDays float64: Admin credentials rotation interval (days)
AwsAccessKeyId string: Access Key ID
AwsAccessSecretKey string: Access Secret Key
AwsExternalId string: The AWS External ID associated with the AWS role (relevant only for assume_role mode)
AwsRoleArns string: AWS Role ARNs to be use in the Assume Role operation. Multiple values should be separated by comma
AwsUserConsoleAccess bool: Enable AWS User console access
AwsUserGroups string: UserGroup name(s). Multiple values should be separated by comma
AwsUserPolicies string: Policy ARN(s). Multiple values should be separated by comma
AwsUserProgrammaticAccess bool: Enable AWS User programmatic access
CustomUsernameTemplate string: Customize how temporary usernames are generated using go template
DeleteProtection string: Protection from accidental deletion of this object [true/false]
Description string: Description of the object
DynamicSecretAwsId string: The ID of this resource.
EnableAdminRotation bool: Automatic admin credentials rotation
EncryptionKeyName string: Encrypt dynamic secret details with following key
ItemCustomFields map[string]string: Additional custom fields to associate with the item
Name string: Dynamic secret name
PasswordLength string: The length of the password to be generated
Region string: Region
SecureAccessAwsAccountId string: The aws account id
SecureAccessAwsNativeCli bool: The aws native cli
SecureAccessAwsRegion string
SecureAccessBastionIssuer string: Path to the SSH Certificate Issuer for your Akeyless Bastion
Deprecated: Deprecated
SecureAccessCertificateIssuer string: Path to the SSH Certificate Issuer for your Akeyless Secure Access
SecureAccessDelay float64: The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
SecureAccessEnable string: Enable/Disable secure remote access, [true/false]
SecureAccessUrl string
SecureAccessWeb bool: Enable Web Secure Remote Access
SecureAccessWebBrowsing bool: Secure browser via Akeyless Web Access Bastion
SecureAccessWebProxy bool: Web-Proxy via Akeyless's Secure Remote Access (SRA)
SessionTags string: Session tags, space separated, relevant only for Assumed Role. Format: Key=name,Value=val Key=name2,Value=val2
Tags []string: List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
TargetName string: Name of existing target to use in dynamic secret creation
TransitiveTagKeys string: Transitive tag keys, space separated, relevant only for Assumed Role
UserTtl string: User TTL

accessMode String: The types of credentials to retrieve from AWS. Options:[iamuser,assumerole]
adminRotationIntervalDays Double: Admin credentials rotation interval (days)
awsAccessKeyId String: Access Key ID
awsAccessSecretKey String: Access Secret Key
awsExternalId String: The AWS External ID associated with the AWS role (relevant only for assume_role mode)
awsRoleArns String: AWS Role ARNs to be use in the Assume Role operation. Multiple values should be separated by comma
awsUserConsoleAccess Boolean: Enable AWS User console access
awsUserGroups String: UserGroup name(s). Multiple values should be separated by comma
awsUserPolicies String: Policy ARN(s). Multiple values should be separated by comma
awsUserProgrammaticAccess Boolean: Enable AWS User programmatic access
customUsernameTemplate String: Customize how temporary usernames are generated using go template
deleteProtection String: Protection from accidental deletion of this object [true/false]
description String: Description of the object
dynamicSecretAwsId String: The ID of this resource.
enableAdminRotation Boolean: Automatic admin credentials rotation
encryptionKeyName String: Encrypt dynamic secret details with following key
itemCustomFields Map<String,String>: Additional custom fields to associate with the item
name String: Dynamic secret name
passwordLength String: The length of the password to be generated
region String: Region
secureAccessAwsAccountId String: The aws account id
secureAccessAwsNativeCli Boolean: The aws native cli
secureAccessAwsRegion String
secureAccessBastionIssuer String: Path to the SSH Certificate Issuer for your Akeyless Bastion
Deprecated: Deprecated
secureAccessCertificateIssuer String: Path to the SSH Certificate Issuer for your Akeyless Secure Access
secureAccessDelay Double: The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
secureAccessEnable String: Enable/Disable secure remote access, [true/false]
secureAccessUrl String
secureAccessWeb Boolean: Enable Web Secure Remote Access
secureAccessWebBrowsing Boolean: Secure browser via Akeyless Web Access Bastion
secureAccessWebProxy Boolean: Web-Proxy via Akeyless's Secure Remote Access (SRA)
sessionTags String: Session tags, space separated, relevant only for Assumed Role. Format: Key=name,Value=val Key=name2,Value=val2
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: Name of existing target to use in dynamic secret creation
transitiveTagKeys String: Transitive tag keys, space separated, relevant only for Assumed Role
userTtl String: User TTL

accessMode string: The types of credentials to retrieve from AWS. Options:[iamuser,assumerole]
adminRotationIntervalDays number: Admin credentials rotation interval (days)
awsAccessKeyId string: Access Key ID
awsAccessSecretKey string: Access Secret Key
awsExternalId string: The AWS External ID associated with the AWS role (relevant only for assume_role mode)
awsRoleArns string: AWS Role ARNs to be use in the Assume Role operation. Multiple values should be separated by comma
awsUserConsoleAccess boolean: Enable AWS User console access
awsUserGroups string: UserGroup name(s). Multiple values should be separated by comma
awsUserPolicies string: Policy ARN(s). Multiple values should be separated by comma
awsUserProgrammaticAccess boolean: Enable AWS User programmatic access
customUsernameTemplate string: Customize how temporary usernames are generated using go template
deleteProtection string: Protection from accidental deletion of this object [true/false]
description string: Description of the object
dynamicSecretAwsId string: The ID of this resource.
enableAdminRotation boolean: Automatic admin credentials rotation
encryptionKeyName string: Encrypt dynamic secret details with following key
itemCustomFields {[key: string]: string}: Additional custom fields to associate with the item
name string: Dynamic secret name
passwordLength string: The length of the password to be generated
region string: Region
secureAccessAwsAccountId string: The aws account id
secureAccessAwsNativeCli boolean: The aws native cli
secureAccessAwsRegion string
secureAccessBastionIssuer string: Path to the SSH Certificate Issuer for your Akeyless Bastion
Deprecated: Deprecated
secureAccessCertificateIssuer string: Path to the SSH Certificate Issuer for your Akeyless Secure Access
secureAccessDelay number: The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
secureAccessEnable string: Enable/Disable secure remote access, [true/false]
secureAccessUrl string
secureAccessWeb boolean: Enable Web Secure Remote Access
secureAccessWebBrowsing boolean: Secure browser via Akeyless Web Access Bastion
secureAccessWebProxy boolean: Web-Proxy via Akeyless's Secure Remote Access (SRA)
sessionTags string: Session tags, space separated, relevant only for Assumed Role. Format: Key=name,Value=val Key=name2,Value=val2
tags string[]: List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
targetName string: Name of existing target to use in dynamic secret creation
transitiveTagKeys string: Transitive tag keys, space separated, relevant only for Assumed Role
userTtl string: User TTL

access_mode str: The types of credentials to retrieve from AWS. Options:[iamuser,assumerole]
admin_rotation_interval_days float: Admin credentials rotation interval (days)
aws_access_key_id str: Access Key ID
aws_access_secret_key str: Access Secret Key
aws_external_id str: The AWS External ID associated with the AWS role (relevant only for assume_role mode)
aws_role_arns str: AWS Role ARNs to be use in the Assume Role operation. Multiple values should be separated by comma
aws_user_console_access bool: Enable AWS User console access
aws_user_groups str: UserGroup name(s). Multiple values should be separated by comma
aws_user_policies str: Policy ARN(s). Multiple values should be separated by comma
aws_user_programmatic_access bool: Enable AWS User programmatic access
custom_username_template str: Customize how temporary usernames are generated using go template
delete_protection str: Protection from accidental deletion of this object [true/false]
description str: Description of the object
dynamic_secret_aws_id str: The ID of this resource.
enable_admin_rotation bool: Automatic admin credentials rotation
encryption_key_name str: Encrypt dynamic secret details with following key
item_custom_fields Mapping[str, str]: Additional custom fields to associate with the item
name str: Dynamic secret name
password_length str: The length of the password to be generated
region str: Region
secure_access_aws_account_id str: The aws account id
secure_access_aws_native_cli bool: The aws native cli
secure_access_aws_region str
secure_access_bastion_issuer str: Path to the SSH Certificate Issuer for your Akeyless Bastion
Deprecated: Deprecated
secure_access_certificate_issuer str: Path to the SSH Certificate Issuer for your Akeyless Secure Access
secure_access_delay float: The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
secure_access_enable str: Enable/Disable secure remote access, [true/false]
secure_access_url str
secure_access_web bool: Enable Web Secure Remote Access
secure_access_web_browsing bool: Secure browser via Akeyless Web Access Bastion
secure_access_web_proxy bool: Web-Proxy via Akeyless's Secure Remote Access (SRA)
session_tags str: Session tags, space separated, relevant only for Assumed Role. Format: Key=name,Value=val Key=name2,Value=val2
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: Name of existing target to use in dynamic secret creation
transitive_tag_keys str: Transitive tag keys, space separated, relevant only for Assumed Role
user_ttl str: User TTL

accessMode String: The types of credentials to retrieve from AWS. Options:[iamuser,assumerole]
adminRotationIntervalDays Number: Admin credentials rotation interval (days)
awsAccessKeyId String: Access Key ID
awsAccessSecretKey String: Access Secret Key
awsExternalId String: The AWS External ID associated with the AWS role (relevant only for assume_role mode)
awsRoleArns String: AWS Role ARNs to be use in the Assume Role operation. Multiple values should be separated by comma
awsUserConsoleAccess Boolean: Enable AWS User console access
awsUserGroups String: UserGroup name(s). Multiple values should be separated by comma
awsUserPolicies String: Policy ARN(s). Multiple values should be separated by comma
awsUserProgrammaticAccess Boolean: Enable AWS User programmatic access
customUsernameTemplate String: Customize how temporary usernames are generated using go template
deleteProtection String: Protection from accidental deletion of this object [true/false]
description String: Description of the object
dynamicSecretAwsId String: The ID of this resource.
enableAdminRotation Boolean: Automatic admin credentials rotation
encryptionKeyName String: Encrypt dynamic secret details with following key
itemCustomFields Map<String>: Additional custom fields to associate with the item
name String: Dynamic secret name
passwordLength String: The length of the password to be generated
region String: Region
secureAccessAwsAccountId String: The aws account id
secureAccessAwsNativeCli Boolean: The aws native cli
secureAccessAwsRegion String
secureAccessBastionIssuer String: Path to the SSH Certificate Issuer for your Akeyless Bastion
Deprecated: Deprecated
secureAccessCertificateIssuer String: Path to the SSH Certificate Issuer for your Akeyless Secure Access
secureAccessDelay Number: The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
secureAccessEnable String: Enable/Disable secure remote access, [true/false]
secureAccessUrl String
secureAccessWeb Boolean: Enable Web Secure Remote Access
secureAccessWebBrowsing Boolean: Secure browser via Akeyless Web Access Bastion
secureAccessWebProxy Boolean: Web-Proxy via Akeyless's Secure Remote Access (SRA)
sessionTags String: Session tags, space separated, relevant only for Assumed Role. Format: Key=name,Value=val Key=name2,Value=val2
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: Name of existing target to use in dynamic secret creation
transitiveTagKeys String: Transitive tag keys, space separated, relevant only for Assumed Role
userTtl String: User TTL

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
UseGwCloudIdentity bool: Use the GW's Cloud IAM

Id string: The provider-assigned unique ID for this managed resource.
UseGwCloudIdentity bool: Use the GW's Cloud IAM

id String: The provider-assigned unique ID for this managed resource.
useGwCloudIdentity Boolean: Use the GW's Cloud IAM

id string: The provider-assigned unique ID for this managed resource.
useGwCloudIdentity boolean: Use the GW's Cloud IAM

id str: The provider-assigned unique ID for this managed resource.
use_gw_cloud_identity bool: Use the GW's Cloud IAM

id String: The provider-assigned unique ID for this managed resource.
useGwCloudIdentity Boolean: Use the GW's Cloud IAM

Look up Existing DynamicSecretAws Resource

Get an existing DynamicSecretAws 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?: DynamicSecretAwsState, opts?: CustomResourceOptions): DynamicSecretAws

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_mode: Optional[str] = None,
        admin_rotation_interval_days: Optional[float] = None,
        aws_access_key_id: Optional[str] = None,
        aws_access_secret_key: Optional[str] = None,
        aws_external_id: Optional[str] = None,
        aws_role_arns: Optional[str] = None,
        aws_user_console_access: Optional[bool] = None,
        aws_user_groups: Optional[str] = None,
        aws_user_policies: Optional[str] = None,
        aws_user_programmatic_access: Optional[bool] = None,
        custom_username_template: Optional[str] = None,
        delete_protection: Optional[str] = None,
        description: Optional[str] = None,
        dynamic_secret_aws_id: Optional[str] = None,
        enable_admin_rotation: Optional[bool] = None,
        encryption_key_name: Optional[str] = None,
        item_custom_fields: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        password_length: Optional[str] = None,
        region: Optional[str] = None,
        secure_access_aws_account_id: Optional[str] = None,
        secure_access_aws_native_cli: Optional[bool] = None,
        secure_access_aws_region: Optional[str] = None,
        secure_access_bastion_issuer: Optional[str] = None,
        secure_access_certificate_issuer: Optional[str] = None,
        secure_access_delay: Optional[float] = None,
        secure_access_enable: Optional[str] = None,
        secure_access_url: Optional[str] = None,
        secure_access_web: Optional[bool] = None,
        secure_access_web_browsing: Optional[bool] = None,
        secure_access_web_proxy: Optional[bool] = None,
        session_tags: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        target_name: Optional[str] = None,
        transitive_tag_keys: Optional[str] = None,
        use_gw_cloud_identity: Optional[bool] = None,
        user_ttl: Optional[str] = None) -> DynamicSecretAws

func GetDynamicSecretAws(ctx *Context, name string, id IDInput, state *DynamicSecretAwsState, opts ...ResourceOption) (*DynamicSecretAws, error)

public static DynamicSecretAws Get(string name, Input<string> id, DynamicSecretAwsState? state, CustomResourceOptions? opts = null)

public static DynamicSecretAws get(String name, Output<String> id, DynamicSecretAwsState state, CustomResourceOptions options)

resources:  _:    type: akeyless:DynamicSecretAws    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:

AccessMode string: The types of credentials to retrieve from AWS. Options:[iamuser,assumerole]
AdminRotationIntervalDays double: Admin credentials rotation interval (days)
AwsAccessKeyId string: Access Key ID
AwsAccessSecretKey string: Access Secret Key
AwsExternalId string: The AWS External ID associated with the AWS role (relevant only for assume_role mode)
AwsRoleArns string: AWS Role ARNs to be use in the Assume Role operation. Multiple values should be separated by comma
AwsUserConsoleAccess bool: Enable AWS User console access
AwsUserGroups string: UserGroup name(s). Multiple values should be separated by comma
AwsUserPolicies string: Policy ARN(s). Multiple values should be separated by comma
AwsUserProgrammaticAccess bool: Enable AWS User programmatic access
CustomUsernameTemplate string: Customize how temporary usernames are generated using go template
DeleteProtection string: Protection from accidental deletion of this object [true/false]
Description string: Description of the object
DynamicSecretAwsId string: The ID of this resource.
EnableAdminRotation bool: Automatic admin credentials rotation
EncryptionKeyName string: Encrypt dynamic secret details with following key
ItemCustomFields Dictionary<string, string>: Additional custom fields to associate with the item
Name string: Dynamic secret name
PasswordLength string: The length of the password to be generated
Region string: Region
SecureAccessAwsAccountId string: The aws account id
SecureAccessAwsNativeCli bool: The aws native cli
SecureAccessAwsRegion string
SecureAccessBastionIssuer string: Path to the SSH Certificate Issuer for your Akeyless Bastion
Deprecated: Deprecated
SecureAccessCertificateIssuer string: Path to the SSH Certificate Issuer for your Akeyless Secure Access
SecureAccessDelay double: The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
SecureAccessEnable string: Enable/Disable secure remote access, [true/false]
SecureAccessUrl string
SecureAccessWeb bool: Enable Web Secure Remote Access
SecureAccessWebBrowsing bool: Secure browser via Akeyless Web Access Bastion
SecureAccessWebProxy bool: Web-Proxy via Akeyless's Secure Remote Access (SRA)
SessionTags string: Session tags, space separated, relevant only for Assumed Role. Format: Key=name,Value=val Key=name2,Value=val2
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: Name of existing target to use in dynamic secret creation
TransitiveTagKeys string: Transitive tag keys, space separated, relevant only for Assumed Role
UseGwCloudIdentity bool: Use the GW's Cloud IAM
UserTtl string: User TTL

AccessMode string: The types of credentials to retrieve from AWS. Options:[iamuser,assumerole]
AdminRotationIntervalDays float64: Admin credentials rotation interval (days)
AwsAccessKeyId string: Access Key ID
AwsAccessSecretKey string: Access Secret Key
AwsExternalId string: The AWS External ID associated with the AWS role (relevant only for assume_role mode)
AwsRoleArns string: AWS Role ARNs to be use in the Assume Role operation. Multiple values should be separated by comma
AwsUserConsoleAccess bool: Enable AWS User console access
AwsUserGroups string: UserGroup name(s). Multiple values should be separated by comma
AwsUserPolicies string: Policy ARN(s). Multiple values should be separated by comma
AwsUserProgrammaticAccess bool: Enable AWS User programmatic access
CustomUsernameTemplate string: Customize how temporary usernames are generated using go template
DeleteProtection string: Protection from accidental deletion of this object [true/false]
Description string: Description of the object
DynamicSecretAwsId string: The ID of this resource.
EnableAdminRotation bool: Automatic admin credentials rotation
EncryptionKeyName string: Encrypt dynamic secret details with following key
ItemCustomFields map[string]string: Additional custom fields to associate with the item
Name string: Dynamic secret name
PasswordLength string: The length of the password to be generated
Region string: Region
SecureAccessAwsAccountId string: The aws account id
SecureAccessAwsNativeCli bool: The aws native cli
SecureAccessAwsRegion string
SecureAccessBastionIssuer string: Path to the SSH Certificate Issuer for your Akeyless Bastion
Deprecated: Deprecated
SecureAccessCertificateIssuer string: Path to the SSH Certificate Issuer for your Akeyless Secure Access
SecureAccessDelay float64: The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
SecureAccessEnable string: Enable/Disable secure remote access, [true/false]
SecureAccessUrl string
SecureAccessWeb bool: Enable Web Secure Remote Access
SecureAccessWebBrowsing bool: Secure browser via Akeyless Web Access Bastion
SecureAccessWebProxy bool: Web-Proxy via Akeyless's Secure Remote Access (SRA)
SessionTags string: Session tags, space separated, relevant only for Assumed Role. Format: Key=name,Value=val Key=name2,Value=val2
Tags []string: List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
TargetName string: Name of existing target to use in dynamic secret creation
TransitiveTagKeys string: Transitive tag keys, space separated, relevant only for Assumed Role
UseGwCloudIdentity bool: Use the GW's Cloud IAM
UserTtl string: User TTL

accessMode String: The types of credentials to retrieve from AWS. Options:[iamuser,assumerole]
adminRotationIntervalDays Double: Admin credentials rotation interval (days)
awsAccessKeyId String: Access Key ID
awsAccessSecretKey String: Access Secret Key
awsExternalId String: The AWS External ID associated with the AWS role (relevant only for assume_role mode)
awsRoleArns String: AWS Role ARNs to be use in the Assume Role operation. Multiple values should be separated by comma
awsUserConsoleAccess Boolean: Enable AWS User console access
awsUserGroups String: UserGroup name(s). Multiple values should be separated by comma
awsUserPolicies String: Policy ARN(s). Multiple values should be separated by comma
awsUserProgrammaticAccess Boolean: Enable AWS User programmatic access
customUsernameTemplate String: Customize how temporary usernames are generated using go template
deleteProtection String: Protection from accidental deletion of this object [true/false]
description String: Description of the object
dynamicSecretAwsId String: The ID of this resource.
enableAdminRotation Boolean: Automatic admin credentials rotation
encryptionKeyName String: Encrypt dynamic secret details with following key
itemCustomFields Map<String,String>: Additional custom fields to associate with the item
name String: Dynamic secret name
passwordLength String: The length of the password to be generated
region String: Region
secureAccessAwsAccountId String: The aws account id
secureAccessAwsNativeCli Boolean: The aws native cli
secureAccessAwsRegion String
secureAccessBastionIssuer String: Path to the SSH Certificate Issuer for your Akeyless Bastion
Deprecated: Deprecated
secureAccessCertificateIssuer String: Path to the SSH Certificate Issuer for your Akeyless Secure Access
secureAccessDelay Double: The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
secureAccessEnable String: Enable/Disable secure remote access, [true/false]
secureAccessUrl String
secureAccessWeb Boolean: Enable Web Secure Remote Access
secureAccessWebBrowsing Boolean: Secure browser via Akeyless Web Access Bastion
secureAccessWebProxy Boolean: Web-Proxy via Akeyless's Secure Remote Access (SRA)
sessionTags String: Session tags, space separated, relevant only for Assumed Role. Format: Key=name,Value=val Key=name2,Value=val2
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: Name of existing target to use in dynamic secret creation
transitiveTagKeys String: Transitive tag keys, space separated, relevant only for Assumed Role
useGwCloudIdentity Boolean: Use the GW's Cloud IAM
userTtl String: User TTL

accessMode string: The types of credentials to retrieve from AWS. Options:[iamuser,assumerole]
adminRotationIntervalDays number: Admin credentials rotation interval (days)
awsAccessKeyId string: Access Key ID
awsAccessSecretKey string: Access Secret Key
awsExternalId string: The AWS External ID associated with the AWS role (relevant only for assume_role mode)
awsRoleArns string: AWS Role ARNs to be use in the Assume Role operation. Multiple values should be separated by comma
awsUserConsoleAccess boolean: Enable AWS User console access
awsUserGroups string: UserGroup name(s). Multiple values should be separated by comma
awsUserPolicies string: Policy ARN(s). Multiple values should be separated by comma
awsUserProgrammaticAccess boolean: Enable AWS User programmatic access
customUsernameTemplate string: Customize how temporary usernames are generated using go template
deleteProtection string: Protection from accidental deletion of this object [true/false]
description string: Description of the object
dynamicSecretAwsId string: The ID of this resource.
enableAdminRotation boolean: Automatic admin credentials rotation
encryptionKeyName string: Encrypt dynamic secret details with following key
itemCustomFields {[key: string]: string}: Additional custom fields to associate with the item
name string: Dynamic secret name
passwordLength string: The length of the password to be generated
region string: Region
secureAccessAwsAccountId string: The aws account id
secureAccessAwsNativeCli boolean: The aws native cli
secureAccessAwsRegion string
secureAccessBastionIssuer string: Path to the SSH Certificate Issuer for your Akeyless Bastion
Deprecated: Deprecated
secureAccessCertificateIssuer string: Path to the SSH Certificate Issuer for your Akeyless Secure Access
secureAccessDelay number: The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
secureAccessEnable string: Enable/Disable secure remote access, [true/false]
secureAccessUrl string
secureAccessWeb boolean: Enable Web Secure Remote Access
secureAccessWebBrowsing boolean: Secure browser via Akeyless Web Access Bastion
secureAccessWebProxy boolean: Web-Proxy via Akeyless's Secure Remote Access (SRA)
sessionTags string: Session tags, space separated, relevant only for Assumed Role. Format: Key=name,Value=val Key=name2,Value=val2
tags string[]: List of the tags attached to this secret. To specify multiple tags use argument multiple times: -t Tag1 -t Tag2
targetName string: Name of existing target to use in dynamic secret creation
transitiveTagKeys string: Transitive tag keys, space separated, relevant only for Assumed Role
useGwCloudIdentity boolean: Use the GW's Cloud IAM
userTtl string: User TTL

access_mode str: The types of credentials to retrieve from AWS. Options:[iamuser,assumerole]
admin_rotation_interval_days float: Admin credentials rotation interval (days)
aws_access_key_id str: Access Key ID
aws_access_secret_key str: Access Secret Key
aws_external_id str: The AWS External ID associated with the AWS role (relevant only for assume_role mode)
aws_role_arns str: AWS Role ARNs to be use in the Assume Role operation. Multiple values should be separated by comma
aws_user_console_access bool: Enable AWS User console access
aws_user_groups str: UserGroup name(s). Multiple values should be separated by comma
aws_user_policies str: Policy ARN(s). Multiple values should be separated by comma
aws_user_programmatic_access bool: Enable AWS User programmatic access
custom_username_template str: Customize how temporary usernames are generated using go template
delete_protection str: Protection from accidental deletion of this object [true/false]
description str: Description of the object
dynamic_secret_aws_id str: The ID of this resource.
enable_admin_rotation bool: Automatic admin credentials rotation
encryption_key_name str: Encrypt dynamic secret details with following key
item_custom_fields Mapping[str, str]: Additional custom fields to associate with the item
name str: Dynamic secret name
password_length str: The length of the password to be generated
region str: Region
secure_access_aws_account_id str: The aws account id
secure_access_aws_native_cli bool: The aws native cli
secure_access_aws_region str
secure_access_bastion_issuer str: Path to the SSH Certificate Issuer for your Akeyless Bastion
Deprecated: Deprecated
secure_access_certificate_issuer str: Path to the SSH Certificate Issuer for your Akeyless Secure Access
secure_access_delay float: The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
secure_access_enable str: Enable/Disable secure remote access, [true/false]
secure_access_url str
secure_access_web bool: Enable Web Secure Remote Access
secure_access_web_browsing bool: Secure browser via Akeyless Web Access Bastion
secure_access_web_proxy bool: Web-Proxy via Akeyless's Secure Remote Access (SRA)
session_tags str: Session tags, space separated, relevant only for Assumed Role. Format: Key=name,Value=val Key=name2,Value=val2
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: Name of existing target to use in dynamic secret creation
transitive_tag_keys str: Transitive tag keys, space separated, relevant only for Assumed Role
use_gw_cloud_identity bool: Use the GW's Cloud IAM
user_ttl str: User TTL

accessMode String: The types of credentials to retrieve from AWS. Options:[iamuser,assumerole]
adminRotationIntervalDays Number: Admin credentials rotation interval (days)
awsAccessKeyId String: Access Key ID
awsAccessSecretKey String: Access Secret Key
awsExternalId String: The AWS External ID associated with the AWS role (relevant only for assume_role mode)
awsRoleArns String: AWS Role ARNs to be use in the Assume Role operation. Multiple values should be separated by comma
awsUserConsoleAccess Boolean: Enable AWS User console access
awsUserGroups String: UserGroup name(s). Multiple values should be separated by comma
awsUserPolicies String: Policy ARN(s). Multiple values should be separated by comma
awsUserProgrammaticAccess Boolean: Enable AWS User programmatic access
customUsernameTemplate String: Customize how temporary usernames are generated using go template
deleteProtection String: Protection from accidental deletion of this object [true/false]
description String: Description of the object
dynamicSecretAwsId String: The ID of this resource.
enableAdminRotation Boolean: Automatic admin credentials rotation
encryptionKeyName String: Encrypt dynamic secret details with following key
itemCustomFields Map<String>: Additional custom fields to associate with the item
name String: Dynamic secret name
passwordLength String: The length of the password to be generated
region String: Region
secureAccessAwsAccountId String: The aws account id
secureAccessAwsNativeCli Boolean: The aws native cli
secureAccessAwsRegion String
secureAccessBastionIssuer String: Path to the SSH Certificate Issuer for your Akeyless Bastion
Deprecated: Deprecated
secureAccessCertificateIssuer String: Path to the SSH Certificate Issuer for your Akeyless Secure Access
secureAccessDelay Number: The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds
secureAccessEnable String: Enable/Disable secure remote access, [true/false]
secureAccessUrl String
secureAccessWeb Boolean: Enable Web Secure Remote Access
secureAccessWebBrowsing Boolean: Secure browser via Akeyless Web Access Bastion
secureAccessWebProxy Boolean: Web-Proxy via Akeyless's Secure Remote Access (SRA)
sessionTags String: Session tags, space separated, relevant only for Assumed Role. Format: Key=name,Value=val Key=name2,Value=val2
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: Name of existing target to use in dynamic secret creation
transitiveTagKeys String: Transitive tag keys, space separated, relevant only for Assumed Role
useGwCloudIdentity Boolean: Use the GW's Cloud IAM
userTtl String: User TTL