1. Registry
  2. Packages
  3. Akeyless Provider
  4. API Docs
  5. TargetAws
Viewing docs for akeyless 2.1.0
published on Thursday, Nov 19, 2026 by akeyless-community
akeyless
Viewing docs for akeyless 2.1.0
published on Thursday, Nov 19, 2026 by akeyless-community

    AWS Target resource

    Create TargetAws Resource

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

    Constructor syntax

    new TargetAws(name: string, args: TargetAwsArgs, opts?: CustomResourceOptions);
    @overload
    def TargetAws(resource_name: str,
                  args: TargetAwsArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def TargetAws(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  access_key_id: Optional[str] = None,
                  max_versions: Optional[str] = None,
                  description: Optional[str] = None,
                  generate_external_id: Optional[bool] = None,
                  keep_prev_version: Optional[str] = None,
                  key: Optional[str] = None,
                  access_key: Optional[str] = None,
                  name: Optional[str] = None,
                  region: Optional[str] = None,
                  retry: Optional[TargetAwsRetryArgs] = None,
                  role_arn: Optional[str] = None,
                  session_token: Optional[str] = None,
                  target_aws_id: Optional[str] = None,
                  use_gw_cloud_identity: Optional[bool] = None)
    func NewTargetAws(ctx *Context, name string, args TargetAwsArgs, opts ...ResourceOption) (*TargetAws, error)
    public TargetAws(string name, TargetAwsArgs args, CustomResourceOptions? opts = null)
    public TargetAws(String name, TargetAwsArgs args)
    public TargetAws(String name, TargetAwsArgs args, CustomResourceOptions options)
    
    type: akeyless:TargetAws
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "akeyless_target_aws" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args TargetAwsArgs
    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 TargetAwsArgs
    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 TargetAwsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TargetAwsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TargetAwsArgs
    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 targetAwsResource = new Akeyless.TargetAws("targetAwsResource", new()
    {
        AccessKeyId = "string",
        MaxVersions = "string",
        Description = "string",
        GenerateExternalId = false,
        KeepPrevVersion = "string",
        Key = "string",
        AccessKey = "string",
        Name = "string",
        Region = "string",
        Retry = new Akeyless.Inputs.TargetAwsRetryArgs
        {
            ErrorMessageRegexes = new[]
            {
                "string",
            },
            IntervalSeconds = 0.0,
            MaxIntervalSeconds = 0.0,
            MaxRetries = 0.0,
            RetryOnStatusCodes = new[]
            {
                0.0,
            },
        },
        RoleArn = "string",
        SessionToken = "string",
        TargetAwsId = "string",
        UseGwCloudIdentity = false,
    });
    
    example, err := akeyless.NewTargetAws(ctx, "targetAwsResource", &akeyless.TargetAwsArgs{
    	AccessKeyId:        pulumi.String("string"),
    	MaxVersions:        pulumi.String("string"),
    	Description:        pulumi.String("string"),
    	GenerateExternalId: pulumi.Bool(false),
    	KeepPrevVersion:    pulumi.String("string"),
    	Key:                pulumi.String("string"),
    	AccessKey:          pulumi.String("string"),
    	Name:               pulumi.String("string"),
    	Region:             pulumi.String("string"),
    	Retry: &akeyless.TargetAwsRetryArgs{
    		ErrorMessageRegexes: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		IntervalSeconds:    pulumi.Float64(0),
    		MaxIntervalSeconds: pulumi.Float64(0),
    		MaxRetries:         pulumi.Float64(0),
    		RetryOnStatusCodes: pulumi.Float64Array{
    			pulumi.Float64(0),
    		},
    	},
    	RoleArn:            pulumi.String("string"),
    	SessionToken:       pulumi.String("string"),
    	TargetAwsId:        pulumi.String("string"),
    	UseGwCloudIdentity: pulumi.Bool(false),
    })
    
    resource "akeyless_target_aws" "targetAwsResource" {
      lifecycle {
        create_before_destroy = true
      }
      access_key_id        = "string"
      max_versions         = "string"
      description          = "string"
      generate_external_id = false
      keep_prev_version    = "string"
      key                  = "string"
      access_key           = "string"
      name                 = "string"
      region               = "string"
      retry = {
        error_message_regexes = ["string"]
        interval_seconds      = 0
        max_interval_seconds  = 0
        max_retries           = 0
        retry_on_status_codes = [0]
      }
      role_arn              = "string"
      session_token         = "string"
      target_aws_id         = "string"
      use_gw_cloud_identity = false
    }
    
    var targetAwsResource = new TargetAws("targetAwsResource", TargetAwsArgs.builder()
        .accessKeyId("string")
        .maxVersions("string")
        .description("string")
        .generateExternalId(false)
        .keepPrevVersion("string")
        .key("string")
        .accessKey("string")
        .name("string")
        .region("string")
        .retry(TargetAwsRetryArgs.builder()
            .errorMessageRegexes("string")
            .intervalSeconds(0.0)
            .maxIntervalSeconds(0.0)
            .maxRetries(0.0)
            .retryOnStatusCodes(0.0)
            .build())
        .roleArn("string")
        .sessionToken("string")
        .targetAwsId("string")
        .useGwCloudIdentity(false)
        .build());
    
    target_aws_resource = akeyless.TargetAws("targetAwsResource",
        access_key_id="string",
        max_versions="string",
        description="string",
        generate_external_id=False,
        keep_prev_version="string",
        key="string",
        access_key="string",
        name="string",
        region="string",
        retry={
            "error_message_regexes": ["string"],
            "interval_seconds": float(0),
            "max_interval_seconds": float(0),
            "max_retries": float(0),
            "retry_on_status_codes": [float(0)],
        },
        role_arn="string",
        session_token="string",
        target_aws_id="string",
        use_gw_cloud_identity=False)
    
    const targetAwsResource = new akeyless.TargetAws("targetAwsResource", {
        accessKeyId: "string",
        maxVersions: "string",
        description: "string",
        generateExternalId: false,
        keepPrevVersion: "string",
        key: "string",
        accessKey: "string",
        name: "string",
        region: "string",
        retry: {
            errorMessageRegexes: ["string"],
            intervalSeconds: 0,
            maxIntervalSeconds: 0,
            maxRetries: 0,
            retryOnStatusCodes: [0],
        },
        roleArn: "string",
        sessionToken: "string",
        targetAwsId: "string",
        useGwCloudIdentity: false,
    });
    
    type: akeyless:TargetAws
    properties:
        accessKey: string
        accessKeyId: string
        description: string
        generateExternalId: false
        keepPrevVersion: string
        key: string
        maxVersions: string
        name: string
        region: string
        retry:
            errorMessageRegexes:
                - string
            intervalSeconds: 0
            maxIntervalSeconds: 0
            maxRetries: 0
            retryOnStatusCodes:
                - 0
        roleArn: string
        sessionToken: string
        targetAwsId: string
        useGwCloudIdentity: false
    

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

    AccessKeyId string
    AWS access key ID
    AccessKey string
    AWS secret access key
    Description string
    Description of the object
    GenerateExternalId bool
    A unique auto-generated value used in your AWS account when configuring your AWS IAM role to securely delegate access to Akeyless. Relevant only when using GW cloud ID
    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 used to encrypt the target 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
    Target name
    Region string
    AWS region
    Retry TargetAwsRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    RoleArn string
    AWS IAM role identifier that Gateway will assume in your AWS account, relevant only when using external ID
    SessionToken string
    Required only for temporary security credentials retrieved using STS
    TargetAwsId string
    The ID of this resource.
    UseGwCloudIdentity bool
    Use the GW's Cloud IAM
    AccessKeyId string
    AWS access key ID
    AccessKey string
    AWS secret access key
    Description string
    Description of the object
    GenerateExternalId bool
    A unique auto-generated value used in your AWS account when configuring your AWS IAM role to securely delegate access to Akeyless. Relevant only when using GW cloud ID
    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 used to encrypt the target 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
    Target name
    Region string
    AWS region
    Retry TargetAwsRetryArgs
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    RoleArn string
    AWS IAM role identifier that Gateway will assume in your AWS account, relevant only when using external ID
    SessionToken string
    Required only for temporary security credentials retrieved using STS
    TargetAwsId string
    The ID of this resource.
    UseGwCloudIdentity bool
    Use the GW's Cloud IAM
    access_key_id string
    AWS access key ID
    access_key string
    AWS secret access key
    description string
    Description of the object
    generate_external_id bool
    A unique auto-generated value used in your AWS account when configuring your AWS IAM role to securely delegate access to Akeyless. Relevant only when using GW cloud ID
    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 used to encrypt the target 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
    Target name
    region string
    AWS region
    retry object
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    role_arn string
    AWS IAM role identifier that Gateway will assume in your AWS account, relevant only when using external ID
    session_token string
    Required only for temporary security credentials retrieved using STS
    target_aws_id string
    The ID of this resource.
    use_gw_cloud_identity bool
    Use the GW's Cloud IAM
    accessKeyId String
    AWS access key ID
    accessKey String
    AWS secret access key
    description String
    Description of the object
    generateExternalId Boolean
    A unique auto-generated value used in your AWS account when configuring your AWS IAM role to securely delegate access to Akeyless. Relevant only when using GW cloud ID
    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 used to encrypt the target 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
    Target name
    region String
    AWS region
    retry TargetAwsRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    roleArn String
    AWS IAM role identifier that Gateway will assume in your AWS account, relevant only when using external ID
    sessionToken String
    Required only for temporary security credentials retrieved using STS
    targetAwsId String
    The ID of this resource.
    useGwCloudIdentity Boolean
    Use the GW's Cloud IAM
    accessKeyId string
    AWS access key ID
    accessKey string
    AWS secret access key
    description string
    Description of the object
    generateExternalId boolean
    A unique auto-generated value used in your AWS account when configuring your AWS IAM role to securely delegate access to Akeyless. Relevant only when using GW cloud ID
    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 used to encrypt the target 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
    Target name
    region string
    AWS region
    retry TargetAwsRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    roleArn string
    AWS IAM role identifier that Gateway will assume in your AWS account, relevant only when using external ID
    sessionToken string
    Required only for temporary security credentials retrieved using STS
    targetAwsId string
    The ID of this resource.
    useGwCloudIdentity boolean
    Use the GW's Cloud IAM
    access_key_id str
    AWS access key ID
    access_key str
    AWS secret access key
    description str
    Description of the object
    generate_external_id bool
    A unique auto-generated value used in your AWS account when configuring your AWS IAM role to securely delegate access to Akeyless. Relevant only when using GW cloud ID
    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 used to encrypt the target 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
    Target name
    region str
    AWS region
    retry TargetAwsRetryArgs
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    role_arn str
    AWS IAM role identifier that Gateway will assume in your AWS account, relevant only when using external ID
    session_token str
    Required only for temporary security credentials retrieved using STS
    target_aws_id str
    The ID of this resource.
    use_gw_cloud_identity bool
    Use the GW's Cloud IAM
    accessKeyId String
    AWS access key ID
    accessKey String
    AWS secret access key
    description String
    Description of the object
    generateExternalId Boolean
    A unique auto-generated value used in your AWS account when configuring your AWS IAM role to securely delegate access to Akeyless. Relevant only when using GW cloud ID
    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 used to encrypt the target 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
    Target name
    region String
    AWS region
    retry Property Map
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    roleArn String
    AWS IAM role identifier that Gateway will assume in your AWS account, relevant only when using external ID
    sessionToken String
    Required only for temporary security credentials retrieved using STS
    targetAwsId String
    The ID of this resource.
    useGwCloudIdentity Boolean
    Use the GW's Cloud IAM

    Outputs

    All input properties are implicitly available as output properties. Additionally, the TargetAws 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 TargetAws Resource

    Get an existing TargetAws 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?: TargetAwsState, opts?: CustomResourceOptions): TargetAws
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            access_key: Optional[str] = None,
            access_key_id: Optional[str] = None,
            description: Optional[str] = None,
            generate_external_id: Optional[bool] = None,
            keep_prev_version: Optional[str] = None,
            key: Optional[str] = None,
            max_versions: Optional[str] = None,
            name: Optional[str] = None,
            region: Optional[str] = None,
            retry: Optional[TargetAwsRetryArgs] = None,
            role_arn: Optional[str] = None,
            session_token: Optional[str] = None,
            target_aws_id: Optional[str] = None,
            use_gw_cloud_identity: Optional[bool] = None) -> TargetAws
    func GetTargetAws(ctx *Context, name string, id IDInput, state *TargetAwsState, opts ...ResourceOption) (*TargetAws, error)
    public static TargetAws Get(string name, Input<string> id, TargetAwsState? state, CustomResourceOptions? opts = null)
    public static TargetAws get(String name, Output<String> id, TargetAwsState state, CustomResourceOptions options)
    resources:  existingTargetAws:    type: akeyless:TargetAws    get:      id: ${id}
    import {
      to = akeyless_target_aws.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    state TargetAwsState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    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 resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state TargetAwsState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    state TargetAwsState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    state TargetAwsState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    options CustomResourceOptions
    Bag of options to control resource's behavior.
    The following state arguments are supported:
    AccessKey string
    AWS secret access key
    AccessKeyId string
    AWS access key ID
    Description string
    Description of the object
    GenerateExternalId bool
    A unique auto-generated value used in your AWS account when configuring your AWS IAM role to securely delegate access to Akeyless. Relevant only when using GW cloud ID
    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 used to encrypt the target 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
    Target name
    Region string
    AWS region
    Retry TargetAwsRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    RoleArn string
    AWS IAM role identifier that Gateway will assume in your AWS account, relevant only when using external ID
    SessionToken string
    Required only for temporary security credentials retrieved using STS
    TargetAwsId string
    The ID of this resource.
    UseGwCloudIdentity bool
    Use the GW's Cloud IAM
    AccessKey string
    AWS secret access key
    AccessKeyId string
    AWS access key ID
    Description string
    Description of the object
    GenerateExternalId bool
    A unique auto-generated value used in your AWS account when configuring your AWS IAM role to securely delegate access to Akeyless. Relevant only when using GW cloud ID
    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 used to encrypt the target 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
    Target name
    Region string
    AWS region
    Retry TargetAwsRetryArgs
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    RoleArn string
    AWS IAM role identifier that Gateway will assume in your AWS account, relevant only when using external ID
    SessionToken string
    Required only for temporary security credentials retrieved using STS
    TargetAwsId string
    The ID of this resource.
    UseGwCloudIdentity bool
    Use the GW's Cloud IAM
    access_key string
    AWS secret access key
    access_key_id string
    AWS access key ID
    description string
    Description of the object
    generate_external_id bool
    A unique auto-generated value used in your AWS account when configuring your AWS IAM role to securely delegate access to Akeyless. Relevant only when using GW cloud ID
    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 used to encrypt the target 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
    Target name
    region string
    AWS region
    retry object
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    role_arn string
    AWS IAM role identifier that Gateway will assume in your AWS account, relevant only when using external ID
    session_token string
    Required only for temporary security credentials retrieved using STS
    target_aws_id string
    The ID of this resource.
    use_gw_cloud_identity bool
    Use the GW's Cloud IAM
    accessKey String
    AWS secret access key
    accessKeyId String
    AWS access key ID
    description String
    Description of the object
    generateExternalId Boolean
    A unique auto-generated value used in your AWS account when configuring your AWS IAM role to securely delegate access to Akeyless. Relevant only when using GW cloud ID
    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 used to encrypt the target 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
    Target name
    region String
    AWS region
    retry TargetAwsRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    roleArn String
    AWS IAM role identifier that Gateway will assume in your AWS account, relevant only when using external ID
    sessionToken String
    Required only for temporary security credentials retrieved using STS
    targetAwsId String
    The ID of this resource.
    useGwCloudIdentity Boolean
    Use the GW's Cloud IAM
    accessKey string
    AWS secret access key
    accessKeyId string
    AWS access key ID
    description string
    Description of the object
    generateExternalId boolean
    A unique auto-generated value used in your AWS account when configuring your AWS IAM role to securely delegate access to Akeyless. Relevant only when using GW cloud ID
    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 used to encrypt the target 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
    Target name
    region string
    AWS region
    retry TargetAwsRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    roleArn string
    AWS IAM role identifier that Gateway will assume in your AWS account, relevant only when using external ID
    sessionToken string
    Required only for temporary security credentials retrieved using STS
    targetAwsId string
    The ID of this resource.
    useGwCloudIdentity boolean
    Use the GW's Cloud IAM
    access_key str
    AWS secret access key
    access_key_id str
    AWS access key ID
    description str
    Description of the object
    generate_external_id bool
    A unique auto-generated value used in your AWS account when configuring your AWS IAM role to securely delegate access to Akeyless. Relevant only when using GW cloud ID
    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 used to encrypt the target 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
    Target name
    region str
    AWS region
    retry TargetAwsRetryArgs
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    role_arn str
    AWS IAM role identifier that Gateway will assume in your AWS account, relevant only when using external ID
    session_token str
    Required only for temporary security credentials retrieved using STS
    target_aws_id str
    The ID of this resource.
    use_gw_cloud_identity bool
    Use the GW's Cloud IAM
    accessKey String
    AWS secret access key
    accessKeyId String
    AWS access key ID
    description String
    Description of the object
    generateExternalId Boolean
    A unique auto-generated value used in your AWS account when configuring your AWS IAM role to securely delegate access to Akeyless. Relevant only when using GW cloud ID
    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 used to encrypt the target 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
    Target name
    region String
    AWS region
    retry Property Map
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    roleArn String
    AWS IAM role identifier that Gateway will assume in your AWS account, relevant only when using external ID
    sessionToken String
    Required only for temporary security credentials retrieved using STS
    targetAwsId String
    The ID of this resource.
    useGwCloudIdentity Boolean
    Use the GW's Cloud IAM

    Supporting Types

    TargetAwsRetry, TargetAwsRetryArgs

    ErrorMessageRegexes List<string>
    Regular expressions matched against the error message. If any matches, the operation is retried.
    IntervalSeconds double
    Wait before the first retry, in seconds. The wait doubles on each retry.
    MaxIntervalSeconds double
    Maximum wait between retries, in seconds.
    MaxRetries double
    Maximum number of retries after the first attempt.
    RetryOnStatusCodes List<double>
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    ErrorMessageRegexes []string
    Regular expressions matched against the error message. If any matches, the operation is retried.
    IntervalSeconds float64
    Wait before the first retry, in seconds. The wait doubles on each retry.
    MaxIntervalSeconds float64
    Maximum wait between retries, in seconds.
    MaxRetries float64
    Maximum number of retries after the first attempt.
    RetryOnStatusCodes []float64
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    error_message_regexes list(string)
    Regular expressions matched against the error message. If any matches, the operation is retried.
    interval_seconds number
    Wait before the first retry, in seconds. The wait doubles on each retry.
    max_interval_seconds number
    Maximum wait between retries, in seconds.
    max_retries number
    Maximum number of retries after the first attempt.
    retry_on_status_codes list(number)
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    errorMessageRegexes List<String>
    Regular expressions matched against the error message. If any matches, the operation is retried.
    intervalSeconds Double
    Wait before the first retry, in seconds. The wait doubles on each retry.
    maxIntervalSeconds Double
    Maximum wait between retries, in seconds.
    maxRetries Double
    Maximum number of retries after the first attempt.
    retryOnStatusCodes List<Double>
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    errorMessageRegexes string[]
    Regular expressions matched against the error message. If any matches, the operation is retried.
    intervalSeconds number
    Wait before the first retry, in seconds. The wait doubles on each retry.
    maxIntervalSeconds number
    Maximum wait between retries, in seconds.
    maxRetries number
    Maximum number of retries after the first attempt.
    retryOnStatusCodes number[]
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    error_message_regexes Sequence[str]
    Regular expressions matched against the error message. If any matches, the operation is retried.
    interval_seconds float
    Wait before the first retry, in seconds. The wait doubles on each retry.
    max_interval_seconds float
    Maximum wait between retries, in seconds.
    max_retries float
    Maximum number of retries after the first attempt.
    retry_on_status_codes Sequence[float]
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    errorMessageRegexes List<String>
    Regular expressions matched against the error message. If any matches, the operation is retried.
    intervalSeconds Number
    Wait before the first retry, in seconds. The wait doubles on each retry.
    maxIntervalSeconds Number
    Maximum wait between retries, in seconds.
    maxRetries Number
    Maximum number of retries after the first attempt.
    retryOnStatusCodes List<Number>
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.

    Package Details

    Repository
    akeyless akeyless-community/terraform-provider-akeyless
    License
    Notes
    This Pulumi package is based on the akeyless Terraform Provider.
    akeyless
    Viewing docs for akeyless 2.1.0
    published on Thursday, Nov 19, 2026 by akeyless-community

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial