defaults | {[ key: string ]: any} | No description. |
workspace | string | No description. |
bucket | string | Name of the S3 Bucket. |
key | string | Path to the state file inside the S3 Bucket. |
accessKey | string | (Optional) AWS access key. |
acl | string | (Optional) Canned ACL to be applied to the state file. |
allowedAccountIds | string[] | (Optional) List of allowed AWS account IDs to prevent potential destruction of a live environment. |
assumeRole | S3BackendAssumeRoleConfig | Assuming an IAM Role can be configured in two ways. |
assumeRolePolicy | string | (Optional) IAM Policy JSON describing further restricting permissions for the IAM Role being assumed. |
assumeRolePolicyArns | string[] | (Optional) Set of Amazon Resource Names (ARNs) of IAM Policies describing further restricting permissions for the IAM Role being assumed. |
assumeRoleTags | {[ key: string ]: string} | (Optional) Map of assume role session tags. |
assumeRoleTransitiveTagKeys | string[] | (Optional) Set of assume role session tag keys to pass to any subsequent sessions. |
assumeRoleWithWebIdentity | S3BackendAssumeRoleWithWebIdentityConfig | Assume Role With Web Identity Configuration. |
customCaBundle | string | (Optional) File containing custom root and intermediate certificates. |
dynamodbEndpoint | string | (Optional) Custom endpoint for the AWS DynamoDB API. |
dynamodbTable | string | (Optional) Name of DynamoDB Table to use for state locking and consistency. |
ec2MetadataServiceEndpoint | string | Optional) Custom endpoint URL for the EC2 Instance Metadata Service (IMDS) API. |
ec2MetadataServiceEndpointMode | string | (Optional) Mode to use in communicating with the metadata service. |
encrypt | boolean | (Optional) Enable server side encryption of the state file. |
endpoint | string | (Optional) Custom endpoint for the AWS S3 API. |
endpoints | S3BackendEndpointConfig | (Optional) The endpoint configuration block. |
externalId | string | (Optional) External identifier to use when assuming the role. |
forbiddenAccountIds | string[] | (Optional) List of forbidden AWS account IDs to prevent potential destruction of a live environment. |
forcePathStyle | boolean | (Optional) Enable path-style S3 URLs (https://< HOST >/< BUCKET > instead of https://< BUCKET >.< HOST >). |
httpProxy | string | (Optional) URL of a proxy to use for HTTP requests when accessing the AWS API. |
httpsProxy | string | (Optional) URL of a proxy to use for HTTPS requests when accessing the AWS API. |
iamEndpoint | string | (Optional) Custom endpoint for the AWS Identity and Access Management (IAM) API. |
insecure | boolean | Optional) Whether to explicitly allow the backend to perform “insecure” SSL requests. |
kmsKeyId | string | (Optional) Amazon Resource Name (ARN) of a Key Management Service (KMS) Key to use for encrypting the state. |
maxRetries | number | (Optional) The maximum number of times an AWS API request is retried on retryable failure. |
noProxy | string | (Optional) Comma-separated list of hosts that should not use HTTP or HTTPS proxies. |
profile | string | (Optional) Name of AWS profile in AWS shared credentials file (e.g. ~/.aws/credentials) or AWS shared configuration file (e.g. ~/.aws/config) to use for credentials and/or configuration. This can also be sourced from the AWS_PROFILE environment variable. |
region | string | AWS Region of the S3 Bucket and DynamoDB Table (if used). |
retryMode | string | (Optional) Specifies how retries are attempted. |
roleArn | string | (Optional) Amazon Resource Name (ARN) of the IAM Role to assume. |
secretKey | string | (Optional) AWS secret access key. |
sessionName | string | (Optional) Session name to use when assuming the role. |
sharedConfigFiles | string[] | (Optional) List of paths to AWS shared configuration files. |
sharedCredentialsFile | string | (Optional) Path to the AWS shared credentials file. |
sharedCredentialsFiles | string[] | (Optional) List of paths to AWS shared credentials files. |
skipCredentialsValidation | boolean | (Optional) Skip credentials validation via the STS API. |
skipMetadataApiCheck | boolean | (Optional) Skip usage of EC2 Metadata API. |
skipRegionValidation | boolean | (Optional) Skip validation of provided region name. |
skipRequestingAccountId | boolean | (Optional) Whether to skip requesting the account ID. |
skipS3Checksum | boolean | (Optional) Do not include checksum when uploading S3 Objects. |
sseCustomerKey | string | (Optional) The key to use for encrypting state with Server-Side Encryption with Customer-Provided Keys (SSE-C). |
stsEndpoint | string | (Optional) Custom endpoint for the AWS Security Token Service (STS) API. |
stsRegion | string | (Optional) AWS region for STS. |
token | string | (Optional) Multi-Factor Authentication (MFA) token. |
useLegacyWorkflow | boolean | (Optional) Use the legacy authentication workflow, preferring environment variables over backend configuration. |
usePathStyle | boolean | (Optional) Enable path-style S3 URLs (https://< HOST >/< BUCKET > instead of https://< BUCKET >.< HOST >). |
workspaceKeyPrefix | string | (Optional) Prefix applied to the state path inside the bucket. |