Typescript: DataTerraformRemoteStateS3Config

Documentation Index

Fetch the complete documentation index at: https://cdktn.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

​

Initializer

import { DataTerraformRemoteStateS3Config } from 'cdktn'

const dataTerraformRemoteStateS3Config: DataTerraformRemoteStateS3Config = { ... }

​

Properties

​

defaults^Optional

public readonly defaults: {[ key: string ]: any};

• Type: {[ key: string ]: any}

​

workspace^Optional

public readonly workspace: string;

• Type: string

​

bucket^Required

public readonly bucket: string;

• Type: string

​

key^Required

public readonly key: string;

• Type: string

​

accessKey^Optional

public readonly accessKey: string;

• Type: string

​

acl^Optional

public readonly acl: string;

• Type: string

​

allowedAccountIds^Optional

public readonly allowedAccountIds: string[];

• Type: string[]

​

assumeRole^Optional

public readonly assumeRole: S3BackendAssumeRoleConfig;

• Type: S3BackendAssumeRoleConfig

​

assumeRolePolicy^Optional

• Deprecated: Use assumeRole.policy instead.

public readonly assumeRolePolicy: string;

• Type: string

​

assumeRolePolicyArns^Optional

• Deprecated: Use assumeRole.policyArns instead.

public readonly assumeRolePolicyArns: string[];

• Type: string[]

​

assumeRoleTags^Optional

• Deprecated: Use assumeRole.tags instead.

public readonly assumeRoleTags: {[ key: string ]: string};

• Type: {[ key: string ]: string}

​

assumeRoleTransitiveTagKeys^Optional

• Deprecated: Use assumeRole.transitiveTagKeys instead.

public readonly assumeRoleTransitiveTagKeys: string[];

• Type: string[]

​

assumeRoleWithWebIdentity^Optional

public readonly assumeRoleWithWebIdentity: S3BackendAssumeRoleWithWebIdentityConfig;

• Type: S3BackendAssumeRoleWithWebIdentityConfig

​

customCaBundle^Optional

public readonly customCaBundle: string;

• Type: string

​

dynamodbEndpoint^Optional

• Deprecated: Use endpoints.dynamodb instead

public readonly dynamodbEndpoint: string;

• Type: string

​

dynamodbTable^Optional

public readonly dynamodbTable: string;

• Type: string

​

ec2MetadataServiceEndpoint^Optional

public readonly ec2MetadataServiceEndpoint: string;

• Type: string

​

ec2MetadataServiceEndpointMode^Optional

public readonly ec2MetadataServiceEndpointMode: string;

• Type: string

​

encrypt^Optional

public readonly encrypt: boolean;

• Type: boolean

​

endpoint^Optional

• Deprecated: Use endpoints.s3 instead

public readonly endpoint: string;

• Type: string

​

endpoints^Optional

public readonly endpoints: S3BackendEndpointConfig;

• Type: S3BackendEndpointConfig

​

externalId^Optional

• Deprecated: Use assume_role.external_id instead.

public readonly externalId: string;

• Type: string

​

forbiddenAccountIds^Optional

public readonly forbiddenAccountIds: string[];

• Type: string[]

​

forcePathStyle^Optional

• Deprecated: Use usePathStyle instead

public readonly forcePathStyle: boolean;

• Type: boolean

​

httpProxy^Optional

public readonly httpProxy: string;

• Type: string

​

httpsProxy^Optional

public readonly httpsProxy: string;

• Type: string

​

iamEndpoint^Optional

• Deprecated: Use endpoints.iam instead

public readonly iamEndpoint: string;

• Type: string

​

insecure^Optional

public readonly insecure: boolean;

• Type: boolean

​

kmsKeyId^Optional

public readonly kmsKeyId: string;

• Type: string

​

maxRetries^Optional

public readonly maxRetries: number;

• Type: number

​

noProxy^Optional

public readonly noProxy: string;

• Type: string

• A domain name
• An IP address
• A CIDR address
• An asterisk (*), to indicate that no proxying should be performed Domain name and IP address values can also include a port number. Can also be set using the NO_PROXY or no_proxy environment variables.

​

profile^Optional

public readonly profile: string;

• Type: string

​

region^Optional

public readonly region: string;

• Type: string

​

retryMode^Optional

public readonly retryMode: string;

• Type: string

​

roleArn^Optional

• Deprecated: Use assumeRole.roleArn instead.

public readonly roleArn: string;

• Type: string

​

secretKey^Optional

public readonly secretKey: string;

• Type: string

​

sessionName^Optional

• Deprecated: Use assumeRole.sessionName instead.

public readonly sessionName: string;

• Type: string

​

sharedConfigFiles^Optional

public readonly sharedConfigFiles: string[];

• Type: string[]

​

sharedCredentialsFile^Optional

public readonly sharedCredentialsFile: string;

• Type: string

​

sharedCredentialsFiles^Optional

public readonly sharedCredentialsFiles: string[];

• Type: string[]

​

skipCredentialsValidation^Optional

public readonly skipCredentialsValidation: boolean;

• Type: boolean

​

skipMetadataApiCheck^Optional

public readonly skipMetadataApiCheck: boolean;

• Type: boolean

​

skipRegionValidation^Optional

public readonly skipRegionValidation: boolean;

• Type: boolean

​

skipRequestingAccountId^Optional

public readonly skipRequestingAccountId: boolean;

• Type: boolean

​

skipS3Checksum^Optional

public readonly skipS3Checksum: boolean;

• Type: boolean

​

sseCustomerKey^Optional

public readonly sseCustomerKey: string;

• Type: string

​

stsEndpoint^Optional

• Deprecated: Use endpoints.sts instead

public readonly stsEndpoint: string;

• Type: string

​

stsRegion^Optional

public readonly stsRegion: string;

• Type: string

​

token^Optional

public readonly token: string;

• Type: string

​

useLegacyWorkflow^Optional

public readonly useLegacyWorkflow: boolean;

• Type: boolean

​

usePathStyle^Optional

public readonly usePathStyle: boolean;

• Type: boolean

​

workspaceKeyPrefix^Optional

public readonly workspaceKeyPrefix: string;

• Type: string