Package com.hashicorp.cdktf.providers.aws.provider

Interface AwsProviderAssumeRole

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    AwsProviderAssumeRole.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-30T04:56:54.457Z")
@Stability(Stable)
public interface AwsProviderAssumeRole
extends software.amazon.jsii.JsiiSerializable

    • Method Detail

      • getDuration

        @Stability(Stable)
@Nullable
default String getDuration()
        The duration, between 15 minutes and 12 hours, of the role session.

        Valid time units are ns, us (or µs), ms, s, h, or m. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs#duration AwsProvider#duration}

      • getExternalId

        @Stability(Stable)
@Nullable
default String getExternalId()
        A unique identifier that might be required when you assume a role in another account.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs#external_id AwsProvider#external_id}

      • getPolicy

        @Stability(Stable)
@Nullable
default String getPolicy()
        IAM Policy JSON describing further restricting permissions for the IAM Role being assumed.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs#policy AwsProvider#policy}

      • getPolicyArns

        @Stability(Stable)
@Nullable
default List<String> getPolicyArns()
        Amazon Resource Names (ARNs) of IAM Policies describing further restricting permissions for the IAM Role being assumed.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs#policy_arns AwsProvider#policy_arns}

      • getRoleArn

        @Stability(Stable)
@Nullable
default String getRoleArn()
        Amazon Resource Name (ARN) of an IAM Role to assume prior to making API calls.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs#role_arn AwsProvider#role_arn}

      • getSessionName

        @Stability(Stable)
@Nullable
default String getSessionName()
        An identifier for the assumed role session.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs#session_name AwsProvider#session_name}

      • getSourceIdentity

        @Stability(Stable)
@Nullable
default String getSourceIdentity()
        Source identity specified by the principal assuming the role.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs#source_identity AwsProvider#source_identity}

      • getTags

        @Stability(Stable)
@Nullable
default Map<String,​String> getTags()
        Assume role session tags.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs#tags AwsProvider#tags}

      • getTransitiveTagKeys

        @Stability(Stable)
@Nullable
default List<String> getTransitiveTagKeys()
        Assume role session tag keys to pass to any subsequent sessions.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs#transitive_tag_keys AwsProvider#transitive_tag_keys}