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

Interface AwsProviderConfig

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

    • Method Detail

      • getAccessKey

        @Stability(Stable)
@Nullable
default String getAccessKey()
        The access key for API operations. You can retrieve this from the 'Security & Credentials' section of the AWS console.

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

      • getAlias

        @Stability(Stable)
@Nullable
default String getAlias()
        Alias name.

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

      • getAllowedAccountIds

        @Stability(Stable)
@Nullable
default List<String> getAllowedAccountIds()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs#allowed_account_ids AwsProvider#allowed_account_ids}.

      • getAssumeRole

        @Stability(Stable)
@Nullable
default Object getAssumeRole()
        assume_role block.

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

      • getAssumeRoleWithWebIdentity

        @Stability(Stable)
@Nullable
default Object getAssumeRoleWithWebIdentity()
        assume_role_with_web_identity block.

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

      • getCustomCaBundle

        @Stability(Stable)
@Nullable
default String getCustomCaBundle()
        File containing custom root and intermediate certificates.

        Can also be configured using the `AWS_CA_BUNDLE` environment variable. (Setting `ca_bundle` in the shared config file is not supported.) Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs#custom_ca_bundle AwsProvider#custom_ca_bundle}

      • getDefaultTags

        @Stability(Stable)
@Nullable
default Object getDefaultTags()
        default_tags block.

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

      • getEc2MetadataServiceEndpoint

        @Stability(Stable)
@Nullable
default String getEc2MetadataServiceEndpoint()
        Address of the EC2 metadata service endpoint to use. Can also be configured using the AWS_EC2_METADATA_SERVICE_ENDPOINT environment variable.

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

      • getEc2MetadataServiceEndpointMode

        @Stability(Stable)
@Nullable
default String getEc2MetadataServiceEndpointMode()
        Protocol to use with EC2 metadata service endpoint.Valid values are IPv4 and IPv6. Can also be configured using the AWS_EC2_METADATA_SERVICE_ENDPOINT_MODE environment variable.

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

      • getEndpoints

        @Stability(Stable)
@Nullable
default Object getEndpoints()
        endpoints block.

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

      • getForbiddenAccountIds

        @Stability(Stable)
@Nullable
default List<String> getForbiddenAccountIds()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs#forbidden_account_ids AwsProvider#forbidden_account_ids}.

      • getHttpProxy

        @Stability(Stable)
@Nullable
default String getHttpProxy()
        The address of an HTTP proxy to use when accessing the AWS API.

        Can also be configured using the `HTTP_PROXY` or `HTTPS_PROXY` environment variables. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs#http_proxy AwsProvider#http_proxy}

      • getIgnoreTags

        @Stability(Stable)
@Nullable
default Object getIgnoreTags()
        ignore_tags block.

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

      • getInsecure

        @Stability(Stable)
@Nullable
default Object getInsecure()
        Explicitly allow the provider to perform "insecure" SSL requests. If omitted, default value is false.

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

      • getMaxRetries

        @Stability(Stable)
@Nullable
default Number getMaxRetries()
        The maximum number of times an AWS API request is being executed.

        If the API request still fails, an error is thrown. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs#max_retries AwsProvider#max_retries}

      • getProfile

        @Stability(Stable)
@Nullable
default String getProfile()
        The profile for API operations. If not set, the default profile created with aws configure will be used.

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

      • getRegion

        @Stability(Stable)
@Nullable
default String getRegion()
        The region where AWS operations will take place. Examples are us-east-1, us-west-2, etc.

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

      • getRetryMode

        @Stability(Stable)
@Nullable
default String getRetryMode()
        Specifies how retries are attempted.

        Valid values are `standard` and `adaptive`. Can also be configured using the `AWS_RETRY_MODE` environment variable. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs#retry_mode AwsProvider#retry_mode}

      • getS3UsePathStyle

        @Stability(Stable)
@Nullable
default Object getS3UsePathStyle()
        Set this to true to enable the request to use path-style addressing, i.e., https://s3.amazonaws.com/BUCKET/KEY. By default, the S3 client will use virtual hosted bucket addressing when possible (https://BUCKET.s3.amazonaws.com/KEY). Specific to the Amazon S3 service.

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

      • getSecretKey

        @Stability(Stable)
@Nullable
default String getSecretKey()
        The secret key for API operations. You can retrieve this from the 'Security & Credentials' section of the AWS console.

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

      • getSharedConfigFiles

        @Stability(Stable)
@Nullable
default List<String> getSharedConfigFiles()
        List of paths to shared config files. If not set, defaults to [~/.aws/config].

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

      • getSharedCredentialsFiles

        @Stability(Stable)
@Nullable
default List<String> getSharedCredentialsFiles()
        List of paths to shared credentials files. If not set, defaults to [~/.aws/credentials].

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

      • getSkipCredentialsValidation

        @Stability(Stable)
@Nullable
default Object getSkipCredentialsValidation()
        Skip the credentials validation via STS API. Used for AWS API implementations that do not have STS available/implemented.

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

      • getSkipMetadataApiCheck

        @Stability(Stable)
@Nullable
default String getSkipMetadataApiCheck()
        Skip the AWS Metadata API check. Used for AWS API implementations that do not have a metadata api endpoint.

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

      • getSkipRegionValidation

        @Stability(Stable)
@Nullable
default Object getSkipRegionValidation()
        Skip static validation of region name.

        Used by users of alternative AWS-like APIs or users w/ access to regions that are not public (yet). Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs#skip_region_validation AwsProvider#skip_region_validation}

      • getSkipRequestingAccountId

        @Stability(Stable)
@Nullable
default Object getSkipRequestingAccountId()
        Skip requesting the account ID. Used for AWS API implementations that do not have IAM/STS API and/or metadata API.

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

      • getStsRegion

        @Stability(Stable)
@Nullable
default String getStsRegion()
        The region where AWS STS operations will take place. Examples are us-east-1 and us-west-2.

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

      • getToken

        @Stability(Stable)
@Nullable
default String getToken()
        session token. A session token is only required if you are using temporary security credentials.

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

      • getUseDualstackEndpoint

        @Stability(Stable)
@Nullable
default Object getUseDualstackEndpoint()
        Resolve an endpoint with DualStack capability.

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

      • getUseFipsEndpoint

        @Stability(Stable)
@Nullable
default Object getUseFipsEndpoint()
        Resolve an endpoint with FIPS capability.

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