ProviderArgs class

The set of arguments for Provider. The set of arguments for Provider.

Constructors

ProviderArgs({Input<String?>? accessKey, Input<List<String>?>? allowedAccountIds, Input<ProviderAssumeRoleWithWebIdentity?>? assumeRoleWithWebIdentity, Input<List<ProviderAssumeRole>?>? assumeRoles, Input<String?>? customCaBundle, Input<ProviderDefaultTags?>? defaultTags, Input<String?>? ec2MetadataServiceEndpoint, Input<String?>? ec2MetadataServiceEndpointMode, Input<List<ProviderEndpoint>?>? endpoints, Input<List<String>?>? forbiddenAccountIds, Input<String?>? httpProxy, Input<String?>? httpsProxy, Input<ProviderIgnoreTags?>? ignoreTags, Input<bool?>? insecure, Input<int?>? maxRetries, Input<String?>? noProxy, Input<String?>? profile, Input<String?>? region, Input<String?>? retryMode, Input<String?>? s3UsEast1RegionalEndpoint, Input<bool?>? s3UsePathStyle, Input<String?>? secretKey, Input<List<String>?>? sharedConfigFiles, Input<List<String>?>? sharedCredentialsFiles, Input<bool?>? skipCredentialsValidation, Input<bool?>? skipMetadataApiCheck, Input<bool?>? skipRegionValidation, Input<bool?>? skipRequestingAccountId, Input<String?>? stsRegion, Input<String?>? tagPolicyCompliance, Input<String?>? token, Input<int?>? tokenBucketRateLimiterCapacity, Input<bool?>? useDualstackEndpoint, Input<bool?>? useFipsEndpoint, Input<List<String>?>? userAgents})
Creates a new ProviderArgs. accessKey The access key for API operations. You can retrieve this allowedAccountIds Optional. assumeRoleWithWebIdentity Optional. assumeRoles Optional. 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 Configuration block with settings to default resource tags across all resources. ec2MetadataServiceEndpoint Address of the EC2 metadata service endpoint to use. Can also be configured using the AWS_EC2_METADATA_SERVICE_ENDPOINT environment variable. 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 Optional. forbiddenAccountIds Optional. 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 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 Configuration block with settings to ignore resource tags across all resources. insecure Explicitly allow the provider to perform "insecure" SSL requests. If omitted, default value is false maxRetries The maximum number of times an AWS API request is 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 The profile for API operations. If not set, the default profile region The region where AWS operations will take place. Examples retryMode Specifies how retries are attempted. Valid values are standard and adaptive. Can also be configured using the AWS_RETRY_MODE environment variable. 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 Set this to true to enable the request to use path-style addressing, secretKey The secret key for API operations. You can retrieve this sharedConfigFiles List of paths to shared config files. If not set, defaults to ~/.aws/config. sharedCredentialsFiles List of paths to shared credentials files. If not set, defaults to ~/.aws/credentials. skipCredentialsValidation Skip the credentials validation via STS API. Used for AWS API implementations that do not have STS available/implemented. skipMetadataApiCheck Skip the AWS Metadata API check. Used for AWS API implementations that do not have a metadata api endpoint. 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 Skip requesting the account ID. Used for AWS API implementations that do not have IAM/STS API and/or metadata API. stsRegion The region where AWS STS operations will take place. Examples 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 session token. A session token is only required if you are tokenBucketRateLimiterCapacity The capacity of the AWS SDK's token bucket rate limiter. useDualstackEndpoint Resolve an endpoint with DualStack capability useFipsEndpoint Resolve an endpoint with FIPS capability userAgents Product details to append to the User-Agent string sent in all AWS API calls.
ProviderArgs.fromMap(Map<String, dynamic> map)
factory

Properties

accessKey → Input<String?>?
The access key for API operations. You can retrieve this from the 'Security & Credentials' section of the AWS console.
final
allowedAccountIds → Input<List<String>?>?
final
assumeRoles → Input<List<ProviderAssumeRole>?>?
final
assumeRoleWithWebIdentity → Input<ProviderAssumeRoleWithWebIdentity?>?
final
customCaBundle → Input<String?>?
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.)
final
defaultTags → Input<ProviderDefaultTags?>?
Configuration block with settings to default resource tags across all resources.
final
ec2MetadataServiceEndpoint → Input<String?>?
Address of the EC2 metadata service endpoint to use. Can also be configured using the AWS_EC2_METADATA_SERVICE_ENDPOINT environment variable.
final
ec2MetadataServiceEndpointMode → Input<String?>?
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.
final
endpoints → Input<List<ProviderEndpoint>?>?
final
forbiddenAccountIds → Input<List<String>?>?
final
hashCode → int
The hash code for this object.
no setterinherited
httpProxy → Input<String?>?
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.
final
httpsProxy → Input<String?>?
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.
final
ignoreTags → Input<ProviderIgnoreTags?>?
Configuration block with settings to ignore resource tags across all resources.
final
insecure → Input<bool?>?
Explicitly allow the provider to perform "insecure" SSL requests. If omitted, default value is false
final
maxRetries → Input<int?>?
The maximum number of times an AWS API request is being executed. If the API request still fails, an error is thrown.
final
noProxy → Input<String?>?
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.
final
profile → Input<String?>?
The profile for API operations. If not set, the default profile created with aws configure will be used.
final
region → Input<String?>?
The region where AWS operations will take place. Examples are us-east-1, us-west-2, etc.
final
retryMode → Input<String?>?
Specifies how retries are attempted. Valid values are standard and adaptive. Can also be configured using the AWS_RETRY_MODE environment variable.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
s3UsEast1RegionalEndpoint → Input<String?>?
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
final
s3UsePathStyle → Input<bool?>?
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.
final
secretKey → Input<String?>?
The secret key for API operations. You can retrieve this from the 'Security & Credentials' section of the AWS console.
final
sharedConfigFiles → Input<List<String>?>?
List of paths to shared config files. If not set, defaults to ~/.aws/config.
final
sharedCredentialsFiles → Input<List<String>?>?
List of paths to shared credentials files. If not set, defaults to ~/.aws/credentials.
final
skipCredentialsValidation → Input<bool?>?
Skip the credentials validation via STS API. Used for AWS API implementations that do not have STS available/implemented.
final
skipMetadataApiCheck → Input<bool?>?
Skip the AWS Metadata API check. Used for AWS API implementations that do not have a metadata api endpoint.
final
skipRegionValidation → Input<bool?>?
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).
final
skipRequestingAccountId → Input<bool?>?
Skip requesting the account ID. Used for AWS API implementations that do not have IAM/STS API and/or metadata API.
final
stsRegion → Input<String?>?
The region where AWS STS operations will take place. Examples are us-east-1 and us-west-2.
final
tagPolicyCompliance → Input<String?>?
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.
final
token → Input<String?>?
session token. A session token is only required if you are using temporary security credentials.
final
tokenBucketRateLimiterCapacity → Input<int?>?
The capacity of the AWS SDK's token bucket rate limiter.
final
useDualstackEndpoint → Input<bool?>?
Resolve an endpoint with DualStack capability
final
useFipsEndpoint → Input<bool?>?
Resolve an endpoint with FIPS capability
final
userAgents → Input<List<String>?>?
Product details to append to the User-Agent string sent in all AWS API calls.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited