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

Class AwsProviderConfig.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • accessKey

        @Stability(Stable)
public AwsProviderConfig.Builder accessKey​(String accessKey)
        Sets the value of AwsProviderConfig.getAccessKey()
        Parameters:
        accessKey - 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}
        Returns:
        this

      • alias

        @Stability(Stable)
public AwsProviderConfig.Builder alias​(String alias)
        Sets the value of AwsProviderConfig.getAlias()
        Parameters:
        alias - Alias name. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs#alias AwsProvider#alias}
        Returns:
        this

      • allowedAccountIds

        @Stability(Stable)
public AwsProviderConfig.Builder allowedAccountIds​(List<String> allowedAccountIds)
        Sets the value of AwsProviderConfig.getAllowedAccountIds()
        Parameters:
        allowedAccountIds - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs#allowed_account_ids AwsProvider#allowed_account_ids}.
        Returns:
        this

      • assumeRole

        @Stability(Stable)
public AwsProviderConfig.Builder assumeRole​(com.hashicorp.cdktf.IResolvable assumeRole)
        Sets the value of AwsProviderConfig.getAssumeRole()
        Parameters:
        assumeRole - assume_role block. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs#assume_role AwsProvider#assume_role}
        Returns:
        this

      • assumeRoleWithWebIdentity

        @Stability(Stable)
public AwsProviderConfig.Builder assumeRoleWithWebIdentity​(com.hashicorp.cdktf.IResolvable assumeRoleWithWebIdentity)
        Sets the value of AwsProviderConfig.getAssumeRoleWithWebIdentity()
        Parameters:
        assumeRoleWithWebIdentity - 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}
        Returns:
        this

      • customCaBundle

        @Stability(Stable)
public AwsProviderConfig.Builder customCaBundle​(String customCaBundle)
        Sets the value of AwsProviderConfig.getCustomCaBundle()
        Parameters:
        customCaBundle - 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}
        Returns:
        this

      • defaultTags

        @Stability(Stable)
public AwsProviderConfig.Builder defaultTags​(com.hashicorp.cdktf.IResolvable defaultTags)
        Sets the value of AwsProviderConfig.getDefaultTags()
        Parameters:
        defaultTags - default_tags block. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs#default_tags AwsProvider#default_tags}
        Returns:
        this

      • ec2MetadataServiceEndpoint

        @Stability(Stable)
public AwsProviderConfig.Builder ec2MetadataServiceEndpoint​(String ec2MetadataServiceEndpoint)
        Sets the value of AwsProviderConfig.getEc2MetadataServiceEndpoint()
        Parameters:
        ec2MetadataServiceEndpoint - 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}
        Returns:
        this

      • ec2MetadataServiceEndpointMode

        @Stability(Stable)
public AwsProviderConfig.Builder ec2MetadataServiceEndpointMode​(String ec2MetadataServiceEndpointMode)
        Sets the value of AwsProviderConfig.getEc2MetadataServiceEndpointMode()
        Parameters:
        ec2MetadataServiceEndpointMode - 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}
        Returns:
        this

      • endpoints

        @Stability(Stable)
public AwsProviderConfig.Builder endpoints​(com.hashicorp.cdktf.IResolvable endpoints)
        Sets the value of AwsProviderConfig.getEndpoints()
        Parameters:
        endpoints - endpoints block. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs#endpoints AwsProvider#endpoints}
        Returns:
        this

      • forbiddenAccountIds

        @Stability(Stable)
public AwsProviderConfig.Builder forbiddenAccountIds​(List<String> forbiddenAccountIds)
        Sets the value of AwsProviderConfig.getForbiddenAccountIds()
        Parameters:
        forbiddenAccountIds - Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs#forbidden_account_ids AwsProvider#forbidden_account_ids}.
        Returns:
        this

      • httpProxy

        @Stability(Stable)
public AwsProviderConfig.Builder httpProxy​(String httpProxy)
        Sets the value of AwsProviderConfig.getHttpProxy()
        Parameters:
        httpProxy - 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}
        Returns:
        this

      • ignoreTags

        @Stability(Stable)
public AwsProviderConfig.Builder ignoreTags​(com.hashicorp.cdktf.IResolvable ignoreTags)
        Sets the value of AwsProviderConfig.getIgnoreTags()
        Parameters:
        ignoreTags - ignore_tags block. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.6.1/docs#ignore_tags AwsProvider#ignore_tags}
        Returns:
        this

      • insecure

        @Stability(Stable)
public AwsProviderConfig.Builder insecure​(Boolean insecure)
        Sets the value of AwsProviderConfig.getInsecure()
        Parameters:
        insecure - 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}
        Returns:
        this

      • insecure

        @Stability(Stable)
public AwsProviderConfig.Builder insecure​(com.hashicorp.cdktf.IResolvable insecure)
        Sets the value of AwsProviderConfig.getInsecure()
        Parameters:
        insecure - 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}
        Returns:
        this

      • maxRetries

        @Stability(Stable)
public AwsProviderConfig.Builder maxRetries​(Number maxRetries)
        Sets the value of AwsProviderConfig.getMaxRetries()
        Parameters:
        maxRetries - 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}
        Returns:
        this

      • profile

        @Stability(Stable)
public AwsProviderConfig.Builder profile​(String profile)
        Sets the value of AwsProviderConfig.getProfile()
        Parameters:
        profile - 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}
        Returns:
        this

      • region

        @Stability(Stable)
public AwsProviderConfig.Builder region​(String region)
        Sets the value of AwsProviderConfig.getRegion()
        Parameters:
        region - 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}
        Returns:
        this

      • retryMode

        @Stability(Stable)
public AwsProviderConfig.Builder retryMode​(String retryMode)
        Sets the value of AwsProviderConfig.getRetryMode()
        Parameters:
        retryMode - 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}
        Returns:
        this

      • s3UsePathStyle

        @Stability(Stable)
public AwsProviderConfig.Builder s3UsePathStyle​(Boolean s3UsePathStyle)
        Sets the value of AwsProviderConfig.getS3UsePathStyle()
        Parameters:
        s3UsePathStyle - 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}
        Returns:
        this

      • s3UsePathStyle

        @Stability(Stable)
public AwsProviderConfig.Builder s3UsePathStyle​(com.hashicorp.cdktf.IResolvable s3UsePathStyle)
        Sets the value of AwsProviderConfig.getS3UsePathStyle()
        Parameters:
        s3UsePathStyle - 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}
        Returns:
        this

      • secretKey

        @Stability(Stable)
public AwsProviderConfig.Builder secretKey​(String secretKey)
        Sets the value of AwsProviderConfig.getSecretKey()
        Parameters:
        secretKey - 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}
        Returns:
        this

      • sharedConfigFiles

        @Stability(Stable)
public AwsProviderConfig.Builder sharedConfigFiles​(List<String> sharedConfigFiles)
        Sets the value of AwsProviderConfig.getSharedConfigFiles()
        Parameters:
        sharedConfigFiles - 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}
        Returns:
        this

      • sharedCredentialsFiles

        @Stability(Stable)
public AwsProviderConfig.Builder sharedCredentialsFiles​(List<String> sharedCredentialsFiles)
        Sets the value of AwsProviderConfig.getSharedCredentialsFiles()
        Parameters:
        sharedCredentialsFiles - 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}
        Returns:
        this

      • skipCredentialsValidation

        @Stability(Stable)
public AwsProviderConfig.Builder skipCredentialsValidation​(Boolean skipCredentialsValidation)
        Sets the value of AwsProviderConfig.getSkipCredentialsValidation()
        Parameters:
        skipCredentialsValidation - 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}
        Returns:
        this

      • skipCredentialsValidation

        @Stability(Stable)
public AwsProviderConfig.Builder skipCredentialsValidation​(com.hashicorp.cdktf.IResolvable skipCredentialsValidation)
        Sets the value of AwsProviderConfig.getSkipCredentialsValidation()
        Parameters:
        skipCredentialsValidation - 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}
        Returns:
        this

      • skipMetadataApiCheck

        @Stability(Stable)
public AwsProviderConfig.Builder skipMetadataApiCheck​(String skipMetadataApiCheck)
        Sets the value of AwsProviderConfig.getSkipMetadataApiCheck()
        Parameters:
        skipMetadataApiCheck - 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}
        Returns:
        this

      • skipRegionValidation

        @Stability(Stable)
public AwsProviderConfig.Builder skipRegionValidation​(Boolean skipRegionValidation)
        Sets the value of AwsProviderConfig.getSkipRegionValidation()
        Parameters:
        skipRegionValidation - 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}
        Returns:
        this

      • skipRegionValidation

        @Stability(Stable)
public AwsProviderConfig.Builder skipRegionValidation​(com.hashicorp.cdktf.IResolvable skipRegionValidation)
        Sets the value of AwsProviderConfig.getSkipRegionValidation()
        Parameters:
        skipRegionValidation - 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}
        Returns:
        this

      • skipRequestingAccountId

        @Stability(Stable)
public AwsProviderConfig.Builder skipRequestingAccountId​(Boolean skipRequestingAccountId)
        Sets the value of AwsProviderConfig.getSkipRequestingAccountId()
        Parameters:
        skipRequestingAccountId - 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}
        Returns:
        this

      • skipRequestingAccountId

        @Stability(Stable)
public AwsProviderConfig.Builder skipRequestingAccountId​(com.hashicorp.cdktf.IResolvable skipRequestingAccountId)
        Sets the value of AwsProviderConfig.getSkipRequestingAccountId()
        Parameters:
        skipRequestingAccountId - 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}
        Returns:
        this

      • stsRegion

        @Stability(Stable)
public AwsProviderConfig.Builder stsRegion​(String stsRegion)
        Sets the value of AwsProviderConfig.getStsRegion()
        Parameters:
        stsRegion - 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}
        Returns:
        this

      • token

        @Stability(Stable)
public AwsProviderConfig.Builder token​(String token)
        Sets the value of AwsProviderConfig.getToken()
        Parameters:
        token - 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}
        Returns:
        this

      • useDualstackEndpoint

        @Stability(Stable)
public AwsProviderConfig.Builder useDualstackEndpoint​(Boolean useDualstackEndpoint)
        Sets the value of AwsProviderConfig.getUseDualstackEndpoint()
        Parameters:
        useDualstackEndpoint - 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}
        Returns:
        this

      • useDualstackEndpoint

        @Stability(Stable)
public AwsProviderConfig.Builder useDualstackEndpoint​(com.hashicorp.cdktf.IResolvable useDualstackEndpoint)
        Sets the value of AwsProviderConfig.getUseDualstackEndpoint()
        Parameters:
        useDualstackEndpoint - 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}
        Returns:
        this

      • useFipsEndpoint

        @Stability(Stable)
public AwsProviderConfig.Builder useFipsEndpoint​(Boolean useFipsEndpoint)
        Sets the value of AwsProviderConfig.getUseFipsEndpoint()
        Parameters:
        useFipsEndpoint - 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}
        Returns:
        this

      • useFipsEndpoint

        @Stability(Stable)
public AwsProviderConfig.Builder useFipsEndpoint​(com.hashicorp.cdktf.IResolvable useFipsEndpoint)
        Sets the value of AwsProviderConfig.getUseFipsEndpoint()
        Parameters:
        useFipsEndpoint - 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}
        Returns:
        this