AWSProvider
laktory.models.resources.providers.AWSProvider
ยค
Bases: BaseProvider, TerraformResource
AWS Provider
Examples:
from laktory import models
p = models.AWSProvider(
access_key="${vars.AWS_ACCESS_KEY}",
)
| PARAMETER | DESCRIPTION |
|---|---|
access_key
|
The access key for API operations. You can retrieve this from the 'Security & Credentials' section of the AWS console.
TYPE:
|
alias
|
TYPE:
|
allowed_account_ids
|
TYPE:
|
assume_role
|
TYPE:
|
assume_role_with_web_identity
|
TYPE:
|
custom_ca_bundle
|
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.)
TYPE:
|
default_tags
|
Configuration block with settings to default resource tags across all resources.
TYPE:
|
ec2_metadata_service_endpoint
|
Address of the EC2 metadata service endpoint to use. Can also be configured using the AWS_EC2_METADATA_SERVICE_ENDPOINT environment variable.
TYPE:
|
ec2_metadata_service_endpoint_mode
|
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.
TYPE:
|
forbidden_account_ids
|
TYPE:
|
http_proxy
|
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.
TYPE:
|
https_proxy
|
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.
TYPE:
|
ignore_tags
|
Configuration block with settings to ignore resource tags across all resources.
TYPE:
|
insecure
|
Explicitly allow the provider to perform 'insecure' SSL requests. If omitted, default value is false
TYPE:
|
max_retries
|
The maximum number of times an AWS API request is being executed. If the API request still fails, an error is thrown.
TYPE:
|
no_proxy
|
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.
TYPE:
|
profile
|
The profile for API operations. If not set, the default profile created with aws configure will be used.
TYPE:
|
region
|
The region where AWS operations will take place. Examples are us-east-1, us-west-2, etc. It can also be sourced from the following environment variables: AWS_REGION, AWS_DEFAULT_REGION
TYPE:
|
retry_mode
|
Specifies how retries are attempted. Valid values are standard and adaptive. Can also be configured using the AWS_RETRY_MODE environment variable.
TYPE:
|
s3_us_east1_regional_endpoint
|
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
TYPE:
|
s3_use_path_style
|
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.
TYPE:
|
secret_key
|
The secret key for API operations. You can retrieve this from the 'Security & Credentials' section of the AWS console.
TYPE:
|
shared_config_files
|
List of paths to shared config files. If not set, defaults to [~/.aws/config].
TYPE:
|
shared_credentials_files
|
List of paths to shared credentials files. If not set, defaults to [~/.aws/credentials].
TYPE:
|
skip_credentials_validation
|
Skip the credentials validation via STS API. Used for AWS API implementations that do not have STS available/implemented.
TYPE:
|
skip_metadata_api_check
|
Skip the AWS Metadata API check. Used for AWS API implementations that do not have a metadata api endpoint.
TYPE:
|
skip_region_validation
|
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).
TYPE:
|
skip_requesting_account_id
|
Skip requesting the account ID. Used for AWS API implementations that do not have IAM/STS API and/or metadata API.
TYPE:
|
source
|
TYPE:
|
sts_region
|
The region where AWS STS operations will take place. Examples are us-east-1 and us-west-2.
TYPE:
|
token
|
Session token. A session token is only required if you are using temporary security credentials.
TYPE:
|
use_dualstack_endpoint
|
Resolve an endpoint with DualStack capability
TYPE:
|
use_fips_endpoint
|
Resolve an endpoint with FIPS capability
TYPE:
|
version
|
TYPE:
|