pulumi-aws-kotlin/com.pulumi.aws.kotlin/ProviderArgs

ProviderArgs

data class ProviderArgs(val accessKey: Output<String>? = null, val allowedAccountIds: Output<List<String>>? = null, val assumeRole: Output<ProviderAssumeRoleArgs>? = null, val assumeRoleWithWebIdentity: Output<ProviderAssumeRoleWithWebIdentityArgs>? = null, val customCaBundle: Output<String>? = null, val defaultTags: Output<ProviderDefaultTagsArgs>? = null, val ec2MetadataServiceEndpoint: Output<String>? = null, val ec2MetadataServiceEndpointMode: Output<String>? = null, val endpoints: Output<List<ProviderEndpointArgs>>? = null, val forbiddenAccountIds: Output<List<String>>? = null, val httpProxy: Output<String>? = null, val httpsProxy: Output<String>? = null, val ignoreTags: Output<ProviderIgnoreTagsArgs>? = null, val insecure: Output<Boolean>? = null, val maxRetries: Output<Int>? = null, val noProxy: Output<String>? = null, val profile: Output<String>? = null, val region: Output<String>? = null, val retryMode: Output<String>? = null, val s3UsEast1RegionalEndpoint: Output<String>? = null, val s3UsePathStyle: Output<Boolean>? = null, val secretKey: Output<String>? = null, val sharedConfigFiles: Output<List<String>>? = null, val sharedCredentialsFiles: Output<List<String>>? = null, val skipCredentialsValidation: Output<Boolean>? = null, val skipMetadataApiCheck: Output<Boolean>? = null, val skipRegionValidation: Output<Boolean>? = null, val skipRequestingAccountId: Output<Boolean>? = null, val stsRegion: Output<String>? = null, val token: Output<String>? = null, val tokenBucketRateLimiterCapacity: Output<Int>? = null, val useDualstackEndpoint: Output<Boolean>? = null, val useFipsEndpoint: Output<Boolean>? = null) : ConvertibleToJava<ProviderArgs>

The provider type for the aws package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

Constructors

ProviderArgs

constructor(accessKey: Output<String>? = null, allowedAccountIds: Output<List<String>>? = null, assumeRole: Output<ProviderAssumeRoleArgs>? = null, assumeRoleWithWebIdentity: Output<ProviderAssumeRoleWithWebIdentityArgs>? = null, customCaBundle: Output<String>? = null, defaultTags: Output<ProviderDefaultTagsArgs>? = null, ec2MetadataServiceEndpoint: Output<String>? = null, ec2MetadataServiceEndpointMode: Output<String>? = null, endpoints: Output<List<ProviderEndpointArgs>>? = null, forbiddenAccountIds: Output<List<String>>? = null, httpProxy: Output<String>? = null, httpsProxy: Output<String>? = null, ignoreTags: Output<ProviderIgnoreTagsArgs>? = null, insecure: Output<Boolean>? = null, maxRetries: Output<Int>? = null, noProxy: Output<String>? = null, profile: Output<String>? = null, region: Output<String>? = null, retryMode: Output<String>? = null, s3UsEast1RegionalEndpoint: Output<String>? = null, s3UsePathStyle: Output<Boolean>? = null, secretKey: Output<String>? = null, sharedConfigFiles: Output<List<String>>? = null, sharedCredentialsFiles: Output<List<String>>? = null, skipCredentialsValidation: Output<Boolean>? = null, skipMetadataApiCheck: Output<Boolean>? = null, skipRegionValidation: Output<Boolean>? = null, skipRequestingAccountId: Output<Boolean>? = null, stsRegion: Output<String>? = null, token: Output<String>? = null, tokenBucketRateLimiterCapacity: Output<Int>? = null, useDualstackEndpoint: Output<Boolean>? = null, useFipsEndpoint: Output<Boolean>? = null)

Properties

accessKey

val accessKey: Output<String>? = null

The access key for API operations. You can retrieve this from the 'Security & Credentials' section of the AWS console.

allowedAccountIds

val allowedAccountIds: Output<List<String>>? = null

assumeRole

val assumeRole: Output<ProviderAssumeRoleArgs>? = null

assumeRoleWithWebIdentity

val assumeRoleWithWebIdentity: Output<ProviderAssumeRoleWithWebIdentityArgs>? = null

customCaBundle

val customCaBundle: Output<String>? = null

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.)

defaultTags

val defaultTags: Output<ProviderDefaultTagsArgs>? = null

Configuration block with settings to default resource tags across all resources.

ec2MetadataServiceEndpoint

val ec2MetadataServiceEndpoint: Output<String>? = null

Address of the EC2 metadata service endpoint to use. Can also be configured using the AWS_EC2_METADATA_SERVICE_ENDPOINT environment variable.

ec2MetadataServiceEndpointMode

val ec2MetadataServiceEndpointMode: Output<String>? = null

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

val endpoints: Output<List<ProviderEndpointArgs>>? = null

forbiddenAccountIds

val forbiddenAccountIds: Output<List<String>>? = null

httpProxy

val httpProxy: Output<String>? = null

URL of a proxy to use for HTTP requests when accessing the AWS API. Can also be set using the HTTP_PROXY or http_proxy environment variables.

httpsProxy

val httpsProxy: Output<String>? = null

URL of a proxy to use for HTTPS requests when accessing the AWS API. Can also be set using the HTTPS_PROXY or https_proxy environment variables.

ignoreTags

val ignoreTags: Output<ProviderIgnoreTagsArgs>? = null

Configuration block with settings to ignore resource tags across all resources.

insecure

val insecure: Output<Boolean>? = null

Explicitly allow the provider to perform "insecure" SSL requests. If omitted, default value is false

maxRetries

val maxRetries: Output<Int>? = null

The maximum number of times an AWS API request is being executed. If the API request still fails, an error is thrown.

noProxy

val noProxy: Output<String>? = null

Comma-separated list of hosts that should not use HTTP or HTTPS proxies. Can also be set using the NO_PROXY or no_proxy environment variables.

profile

val profile: Output<String>? = null

The profile for API operations. If not set, the default profile created with aws configure will be used.

region

val region: Output<String>? = null

The region where AWS operations will take place. Examples are us-east-1, us-west-2, etc.

retryMode

val retryMode: Output<String>? = null

Specifies how retries are attempted. Valid values are standard and adaptive. Can also be configured using the AWS_RETRY_MODE environment variable.

s3UsEast1RegionalEndpoint

val s3UsEast1RegionalEndpoint: Output<String>? = null

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 s3_us_east_1_regional_endpoint shared config file parameter

s3UsePathStyle

val s3UsePathStyle: Output<Boolean>? = null

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

val secretKey: Output<String>? = null

The secret key for API operations. You can retrieve this from the 'Security & Credentials' section of the AWS console.

sharedConfigFiles

val sharedConfigFiles: Output<List<String>>? = null

List of paths to shared config files. If not set, defaults to ~/.aws/config.

sharedCredentialsFiles

val sharedCredentialsFiles: Output<List<String>>? = null

List of paths to shared credentials files. If not set, defaults to ~/.aws/credentials.

skipCredentialsValidation

val skipCredentialsValidation: Output<Boolean>? = null

Skip the credentials validation via STS API. Used for AWS API implementations that do not have STS available/implemented.

skipMetadataApiCheck

val skipMetadataApiCheck: Output<Boolean>? = null

Skip the AWS Metadata API check. Used for AWS API implementations that do not have a metadata api endpoint.

skipRegionValidation

val skipRegionValidation: Output<Boolean>? = null

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

val skipRequestingAccountId: Output<Boolean>? = null

Skip requesting the account ID. Used for AWS API implementations that do not have IAM/STS API and/or metadata API.

stsRegion

val stsRegion: Output<String>? = null

The region where AWS STS operations will take place. Examples are us-east-1 and us-west-2.

token

val token: Output<String>? = null

session token. A session token is only required if you are using temporary security credentials.

tokenBucketRateLimiterCapacity

val tokenBucketRateLimiterCapacity: Output<Int>? = null

The capacity of the AWS SDK's token bucket rate limiter.

useDualstackEndpoint

val useDualstackEndpoint: Output<Boolean>? = null

Resolve an endpoint with DualStack capability

useFipsEndpoint

val useFipsEndpoint: Output<Boolean>? = null

Resolve an endpoint with FIPS capability

Functions

toJava

open override fun toJava(): ProviderArgs