ProviderArgs class
The set of arguments for Provider. The set of arguments for Provider.
Constructors
-
ProviderArgs({Input<
String?> ? accessKey, Input<List< ? allowedAccountIds, Input<String> ?>ProviderAssumeRoleWithWebIdentity?> ? assumeRoleWithWebIdentity, Input<List< ? assumeRoles, Input<ProviderAssumeRole> ?>String?> ? customCaBundle, Input<ProviderDefaultTags?> ? defaultTags, Input<String?> ? ec2MetadataServiceEndpoint, Input<String?> ? ec2MetadataServiceEndpointMode, Input<List< ? endpoints, Input<ProviderEndpoint> ?>List< ? forbiddenAccountIds, Input<String> ?>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<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< ? userAgents})String> ?> -
Creates a new ProviderArgs.
accessKeyThe access key for API operations. You can retrieve thisallowedAccountIdsOptional.assumeRoleWithWebIdentityOptional.assumeRolesOptional.customCaBundleFile containing custom root and intermediate certificates. Can also be configured using theAWS_CA_BUNDLEenvironment variable. (SettingcaBundlein the shared config file is not supported.)defaultTagsConfiguration block with settings to default resource tags across all resources.ec2MetadataServiceEndpointAddress of the EC2 metadata service endpoint to use. Can also be configured using theAWS_EC2_METADATA_SERVICE_ENDPOINTenvironment variable.ec2MetadataServiceEndpointModeProtocol to use with EC2 metadata service endpoint.Valid values areIPv4andIPv6. Can also be configured using theAWS_EC2_METADATA_SERVICE_ENDPOINT_MODEenvironment variable.endpointsOptional.forbiddenAccountIdsOptional.httpProxyURL of a proxy to use for HTTP requests when accessing the AWS API. Can also be set using theHTTP_PROXYorhttpProxyenvironment variables.httpsProxyURL of a proxy to use for HTTPS requests when accessing the AWS API. Can also be set using theHTTPS_PROXYorhttpsProxyenvironment variables.ignoreTagsConfiguration block with settings to ignore resource tags across all resources.insecureExplicitly allow the provider to perform "insecure" SSL requests. If omitted, default value isfalsemaxRetriesThe maximum number of times an AWS API request isnoProxyComma-separated list of hosts that should not use HTTP or HTTPS proxies. Can also be set using theNO_PROXYornoProxyenvironment variables.profileThe profile for API operations. If not set, the default profileregionThe region where AWS operations will take place. ExamplesretryModeSpecifies how retries are attempted. Valid values arestandardandadaptive. Can also be configured using theAWS_RETRY_MODEenvironment variable.s3UsEast1RegionalEndpointSpecifies whether S3 API calls in theus-east-1region use the legacy global endpoint or a regional endpoint. Valid values arelegacyorregional. Can also be configured using theAWS_S3_US_EAST_1_REGIONAL_ENDPOINTenvironment variable or thes3UsEast1RegionalEndpointshared config file parameters3UsePathStyleSet this to true to enable the request to use path-style addressing,secretKeyThe secret key for API operations. You can retrieve thissharedConfigFilesList of paths to shared config files. If not set, defaults to~/.aws/config.sharedCredentialsFilesList of paths to shared credentials files. If not set, defaults to~/.aws/credentials.skipCredentialsValidationSkip the credentials validation via STS API. Used for AWS API implementations that do not have STS available/implemented.skipMetadataApiCheckSkip the AWS Metadata API check. Used for AWS API implementations that do not have a metadata api endpoint.skipRegionValidationSkip static validation of region name. Used by users of alternative AWS-like APIs or users w/ access to regions that are not public (yet).skipRequestingAccountIdSkip requesting the account ID. Used for AWS API implementations that do not have IAM/STS API and/or metadata API.stsRegionThe region where AWS STS operations will take place. ExamplestagPolicyComplianceThe 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.tokensession token. A session token is only required if you aretokenBucketRateLimiterCapacityThe capacity of the AWS SDK's token bucket rate limiter.useDualstackEndpointResolve an endpoint with DualStack capabilityuseFipsEndpointResolve an endpoint with FIPS capabilityuserAgentsProduct 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_BUNDLEenvironment variable. (SettingcaBundlein 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_ENDPOINTenvironment variable.final -
ec2MetadataServiceEndpointMode
→ Input<
String?> ? -
Protocol to use with EC2 metadata service endpoint.Valid values are
IPv4andIPv6. Can also be configured using theAWS_EC2_METADATA_SERVICE_ENDPOINT_MODEenvironment 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_PROXYorhttpProxyenvironment 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_PROXYorhttpsProxyenvironment 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
falsefinal -
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_PROXYornoProxyenvironment variables.final -
profile
→ Input<
String?> ? -
The profile for API operations. If not set, the default profile
created with
aws configurewill 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
standardandadaptive. Can also be configured using theAWS_RETRY_MODEenvironment 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-1region use the legacy global endpoint or a regional endpoint. Valid values arelegacyorregional. Can also be configured using theAWS_S3_US_EAST_1_REGIONAL_ENDPOINTenvironment variable or thes3UsEast1RegionalEndpointshared config file parameterfinal -
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
-
List of paths to shared config files. If not set, defaults to
~/.aws/config.final -
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