Package com.pulumi.aws

Class Config

  • public final class Config
extends java.lang.Object

    • Constructor Summary

      Constructors 
      Constructor Description
      Config()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Optional<java.lang.String> accessKey()
      The access key for API operations.
      java.util.Optional<java.util.List<java.lang.String>> allowedAccountIds()  
      java.util.Optional<java.util.List<AssumeRoles>> assumeRoles()  
      java.util.Optional<AssumeRoleWithWebIdentity> assumeRoleWithWebIdentity()  
      java.util.Optional<java.lang.String> customCaBundle()
      File containing custom root and intermediate certificates.
      java.util.Optional<DefaultTags> defaultTags()
      Configuration block with settings to default resource tags across all resources.
      java.util.Optional<java.lang.String> ec2MetadataServiceEndpoint()
      Address of the EC2 metadata service endpoint to use.
      java.util.Optional<java.lang.String> ec2MetadataServiceEndpointMode()
      Protocol to use with EC2 metadata service endpoint.Valid values are `IPv4` and `IPv6`.
      java.util.Optional<java.util.List<Endpoints>> endpoints()  
      java.util.Optional<java.util.List<java.lang.String>> forbiddenAccountIds()  
      java.util.Optional<java.lang.String> httpProxy()
      URL of a proxy to use for HTTP requests when accessing the AWS API.
      java.util.Optional<java.lang.String> httpsProxy()
      URL of a proxy to use for HTTPS requests when accessing the AWS API.
      java.util.Optional<IgnoreTags> ignoreTags()
      Configuration block with settings to ignore resource tags across all resources.
      java.util.Optional<java.lang.Boolean> insecure()
      Explicitly allow the provider to perform "insecure" SSL requests.
      java.util.Optional<java.lang.Integer> maxRetries()
      The maximum number of times an AWS API request is being executed.
      java.util.Optional<java.lang.String> noProxy()
      Comma-separated list of hosts that should not use HTTP or HTTPS proxies.
      java.util.Optional<java.lang.String> profile()
      The profile for API operations.
      java.util.Optional<java.lang.String> region()
      The region where AWS operations will take place.
      java.util.Optional<java.lang.String> retryMode()
      Specifies how retries are attempted.
      java.util.Optional<java.lang.String> s3UsEast1RegionalEndpoint()
      Specifies whether S3 API calls in the `us-east-1` region use the legacy global endpoint or a regional endpoint.
      java.util.Optional<java.lang.Boolean> s3UsePathStyle()
      Set this to true to enable the request to use path-style addressing, i.e., https://s3.amazonaws.com/BUCKET/KEY.
      java.util.Optional<java.lang.String> secretKey()
      The secret key for API operations.
      java.util.Optional<java.util.List<java.lang.String>> sharedConfigFiles()
      List of paths to shared config files.
      java.util.Optional<java.util.List<java.lang.String>> sharedCredentialsFiles()
      List of paths to shared credentials files.
      java.util.Optional<java.lang.Boolean> skipCredentialsValidation()
      Skip the credentials validation via STS API.
      java.util.Optional<java.lang.Boolean> skipMetadataApiCheck()
      Skip the AWS Metadata API check.
      java.util.Optional<java.lang.Boolean> skipRegionValidation()
      Skip static validation of region name.
      java.util.Optional<java.lang.Boolean> skipRequestingAccountId()
      Skip requesting the account ID.
      java.util.Optional<java.lang.String> stsRegion()
      The region where AWS STS operations will take place.
      java.util.Optional<java.lang.String> tagPolicyCompliance()
      The severity with which to enforce organizational tagging policies on resources managed by this provider instance.
      java.util.Optional<java.lang.String> token()
      session token.
      java.util.Optional<java.lang.Integer> tokenBucketRateLimiterCapacity()
      The capacity of the AWS SDK's token bucket rate limiter.
      java.util.Optional<java.lang.Boolean> useDualstackEndpoint()
      Resolve an endpoint with DualStack capability
      java.util.Optional<java.lang.Boolean> useFipsEndpoint()
      Resolve an endpoint with FIPS capability
      java.util.Optional<java.util.List<java.lang.String>> userAgents()
      Product details to append to the User-Agent string sent in all AWS API calls.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Config

        public Config()

    • Method Detail

      • accessKey

        public java.util.Optional<java.lang.String> accessKey()
        The access key for API operations. You can retrieve this from the 'Security & Credentials' section of the AWS console.

      • allowedAccountIds

        public java.util.Optional<java.util.List<java.lang.String>> allowedAccountIds()

      • assumeRoles

        public java.util.Optional<java.util.List<AssumeRoles>> assumeRoles()

      • customCaBundle

        public java.util.Optional<java.lang.String> customCaBundle()
        File containing custom root and intermediate certificates. Can also be configured using the `AWS_CA_BUNDLE` environment variable. (Setting `caBundle` in the shared config file is not supported.)

      • defaultTags

        public java.util.Optional<DefaultTags> defaultTags()
        Configuration block with settings to default resource tags across all resources.

      • ec2MetadataServiceEndpoint

        public java.util.Optional<java.lang.String> ec2MetadataServiceEndpoint()
        Address of the EC2 metadata service endpoint to use. Can also be configured using the `AWS_EC2_METADATA_SERVICE_ENDPOINT` environment variable.

      • ec2MetadataServiceEndpointMode

        public java.util.Optional<java.lang.String> 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.

      • endpoints

        public java.util.Optional<java.util.List<Endpoints>> endpoints()

      • forbiddenAccountIds

        public java.util.Optional<java.util.List<java.lang.String>> forbiddenAccountIds()

      • httpProxy

        public java.util.Optional<java.lang.String> httpProxy()
        URL of a proxy to use for HTTP requests when accessing the AWS API. Can also be set using the `HTTP_PROXY` or `httpProxy` environment variables.

      • httpsProxy

        public java.util.Optional<java.lang.String> httpsProxy()
        URL of a proxy to use for HTTPS requests when accessing the AWS API. Can also be set using the `HTTPS_PROXY` or `httpsProxy` environment variables.

      • ignoreTags

        public java.util.Optional<IgnoreTags> ignoreTags()
        Configuration block with settings to ignore resource tags across all resources.

      • insecure

        public java.util.Optional<java.lang.Boolean> insecure()
        Explicitly allow the provider to perform "insecure" SSL requests. If omitted, default value is `false`

      • maxRetries

        public java.util.Optional<java.lang.Integer> maxRetries()
        The maximum number of times an AWS API request is being executed. If the API request still fails, an error is thrown.

      • noProxy

        public java.util.Optional<java.lang.String> noProxy()
        Comma-separated list of hosts that should not use HTTP or HTTPS proxies. Can also be set using the `NO_PROXY` or `noProxy` environment variables.

      • profile

        public java.util.Optional<java.lang.String> profile()
        The profile for API operations. If not set, the default profile created with `aws configure` will be used.

      • region

        public java.util.Optional<java.lang.String> region()
        The region where AWS operations will take place. Examples are us-east-1, us-west-2, etc.

      • retryMode

        public java.util.Optional<java.lang.String> retryMode()
        Specifies how retries are attempted. Valid values are `standard` and `adaptive`. Can also be configured using the `AWS_RETRY_MODE` environment variable.

      • s3UsEast1RegionalEndpoint

        public java.util.Optional<java.lang.String> s3UsEast1RegionalEndpoint()
        Specifies whether S3 API calls in the `us-east-1` region use the legacy global endpoint or a regional endpoint. Valid values are `legacy` or `regional`. Can also be configured using the `AWS_S3_US_EAST_1_REGIONAL_ENDPOINT` environment variable or the `s3UsEast1RegionalEndpoint` shared config file parameter

      • s3UsePathStyle

        public java.util.Optional<java.lang.Boolean> 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.

      • secretKey

        public java.util.Optional<java.lang.String> secretKey()
        The secret key for API operations. You can retrieve this from the 'Security & Credentials' section of the AWS console.

      • sharedConfigFiles

        public java.util.Optional<java.util.List<java.lang.String>> sharedConfigFiles()
        List of paths to shared config files. If not set, defaults to [~/.aws/config].

      • sharedCredentialsFiles

        public java.util.Optional<java.util.List<java.lang.String>> sharedCredentialsFiles()
        List of paths to shared credentials files. If not set, defaults to [~/.aws/credentials].

      • skipCredentialsValidation

        public java.util.Optional<java.lang.Boolean> skipCredentialsValidation()
        Skip the credentials validation via STS API. Used for AWS API implementations that do not have STS available/implemented.

      • skipMetadataApiCheck

        public java.util.Optional<java.lang.Boolean> skipMetadataApiCheck()
        Skip the AWS Metadata API check. Used for AWS API implementations that do not have a metadata api endpoint.

      • skipRegionValidation

        public java.util.Optional<java.lang.Boolean> 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).

      • skipRequestingAccountId

        public java.util.Optional<java.lang.Boolean> skipRequestingAccountId()
        Skip requesting the account ID. Used for AWS API implementations that do not have IAM/STS API and/or metadata API.

      • stsRegion

        public java.util.Optional<java.lang.String> stsRegion()
        The region where AWS STS operations will take place. Examples are us-east-1 and us-west-2.

      • tagPolicyCompliance

        public java.util.Optional<java.lang.String> tagPolicyCompliance()
        The severity with which to enforce organizational tagging policies on resources managed by this provider instance. At this time this only includes compliance with required tag keys by resource type. Valid values are "error", "warning", and "disabled". When unset or "disabled", tag policy compliance will not be enforced by the provider. Can also be configured with the TF_AWS_TAG_POLICY_COMPLIANCE environment variable.

      • token

        public java.util.Optional<java.lang.String> token()
        session token. A session token is only required if you are using temporary security credentials.

      • tokenBucketRateLimiterCapacity

        public java.util.Optional<java.lang.Integer> tokenBucketRateLimiterCapacity()
        The capacity of the AWS SDK's token bucket rate limiter.

      • useDualstackEndpoint

        public java.util.Optional<java.lang.Boolean> useDualstackEndpoint()
        Resolve an endpoint with DualStack capability

      • useFipsEndpoint

        public java.util.Optional<java.lang.Boolean> useFipsEndpoint()
        Resolve an endpoint with FIPS capability

      • userAgents

        public java.util.Optional<java.util.List<java.lang.String>> userAgents()
        Product details to append to the User-Agent string sent in all AWS API calls.