Skip to content

Latest commit

 

History

History
1723 lines (1070 loc) · 75 KB

s3AccessPoint.md

File metadata and controls

1723 lines (1070 loc) · 75 KB

aws_s3_access_point

Refer to the Terraform Registory for docs: aws_s3_access_point.

s3AccessPoint Submodule

Constructs

S3AccessPoint

Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/s3_access_point aws_s3_access_point}.

Initializers 

import { s3AccessPoint } from '@cdktf/aws-cdk'

new s3AccessPoint.S3AccessPoint(scope: Construct, id: string, config: S3AccessPointConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config S3AccessPointConfig No description.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configRequired

Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
putPublicAccessBlockConfiguration No description.
putVpcConfiguration No description.
resetAccountId No description.
resetId No description.
resetPolicy No description.
resetPublicAccessBlockConfiguration No description.
resetVpcConfiguration No description.
toString 
public toString(): string

Returns a string representation of this construct.

addOverride 
public addOverride(path: string, value: any): void
pathRequired
  • Type: string
valueRequired
  • Type: any
overrideLogicalId 
public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toMetadata 
public toMetadata(): any
toTerraform 
public toTerraform(): any

Adds this resource to the terraform JSON output.

getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
putPublicAccessBlockConfiguration 
public putPublicAccessBlockConfiguration(value: S3AccessPointPublicAccessBlockConfiguration): void
valueRequired
putVpcConfiguration 
public putVpcConfiguration(value: S3AccessPointVpcConfiguration): void
valueRequired
resetAccountId 
public resetAccountId(): void
resetId 
public resetId(): void
resetPolicy 
public resetPolicy(): void
resetPublicAccessBlockConfiguration 
public resetPublicAccessBlockConfiguration(): void
resetVpcConfiguration 
public resetVpcConfiguration(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformResource No description.
isConstruct 
import { s3AccessPoint } from '@cdktf/aws-cdk'

s3AccessPoint.S3AccessPoint.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: any

Any object.

isTerraformElement 
import { s3AccessPoint } from '@cdktf/aws-cdk'

s3AccessPoint.S3AccessPoint.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { s3AccessPoint } from '@cdktf/aws-cdk'

s3AccessPoint.S3AccessPoint.isTerraformResource(x: any)
xRequired
  • Type: any

Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktf.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn string[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
alias string No description.
arn string No description.
domainName string No description.
endpoints cdktf.StringMap No description.
hasPublicAccessPolicy cdktf.IResolvable No description.
networkOrigin string No description.
publicAccessBlockConfiguration S3AccessPointPublicAccessBlockConfigurationOutputReference No description.
vpcConfiguration S3AccessPointVpcConfigurationOutputReference No description.
accountIdInput string No description.
bucketInput string No description.
idInput string No description.
nameInput string No description.
policyInput string No description.
publicAccessBlockConfigurationInput S3AccessPointPublicAccessBlockConfiguration No description.
vpcConfigurationInput S3AccessPointVpcConfiguration No description.
accountId string No description.
bucket string No description.
id string No description.
name string No description.
policy string No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cdktfStackRequired 
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack
fqnRequired 
public readonly fqn: string;
  • Type: string
friendlyUniqueIdRequired 
public readonly friendlyUniqueId: string;
  • Type: string
terraformMetaArgumentsRequired 
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}
terraformResourceTypeRequired 
public readonly terraformResourceType: string;
  • Type: string
terraformGeneratorMetadataOptional 
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: string[];
  • Type: string[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
aliasRequired 
public readonly alias: string;
  • Type: string
arnRequired 
public readonly arn: string;
  • Type: string
domainNameRequired 
public readonly domainName: string;
  • Type: string
endpointsRequired 
public readonly endpoints: StringMap;
  • Type: cdktf.StringMap
hasPublicAccessPolicyRequired 
public readonly hasPublicAccessPolicy: IResolvable;
  • Type: cdktf.IResolvable
networkOriginRequired 
public readonly networkOrigin: string;
  • Type: string
publicAccessBlockConfigurationRequired 
public readonly publicAccessBlockConfiguration: S3AccessPointPublicAccessBlockConfigurationOutputReference;
vpcConfigurationRequired 
public readonly vpcConfiguration: S3AccessPointVpcConfigurationOutputReference;
accountIdInputOptional 
public readonly accountIdInput: string;
  • Type: string
bucketInputOptional 
public readonly bucketInput: string;
  • Type: string
idInputOptional 
public readonly idInput: string;
  • Type: string
nameInputOptional 
public readonly nameInput: string;
  • Type: string
policyInputOptional 
public readonly policyInput: string;
  • Type: string
publicAccessBlockConfigurationInputOptional 
public readonly publicAccessBlockConfigurationInput: S3AccessPointPublicAccessBlockConfiguration;
vpcConfigurationInputOptional 
public readonly vpcConfigurationInput: S3AccessPointVpcConfiguration;
accountIdRequired 
public readonly accountId: string;
  • Type: string
bucketRequired 
public readonly bucket: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
policyRequired 
public readonly policy: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

S3AccessPointConfig

Initializer 

import { s3AccessPoint } from '@cdktf/aws-cdk'

const s3AccessPointConfig: s3AccessPoint.S3AccessPointConfig = { ... }

Properties

Name Type Description
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn cdktf.ITerraformDependable[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
bucket string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/s3_access_point#bucket S3AccessPoint#bucket}.
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/s3_access_point#name S3AccessPoint#name}.
accountId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/s3_access_point#account_id S3AccessPoint#account_id}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/s3_access_point#id S3AccessPoint#id}.
policy string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/s3_access_point#policy S3AccessPoint#policy}.
publicAccessBlockConfiguration S3AccessPointPublicAccessBlockConfiguration public_access_block_configuration block.
vpcConfiguration S3AccessPointVpcConfiguration vpc_configuration block.
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
bucketRequired 
public readonly bucket: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/s3_access_point#bucket S3AccessPoint#bucket}.

nameRequired 
public readonly name: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/s3_access_point#name S3AccessPoint#name}.

accountIdOptional 
public readonly accountId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/s3_access_point#account_id S3AccessPoint#account_id}.

idOptional 
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/s3_access_point#id S3AccessPoint#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

policyOptional 
public readonly policy: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/s3_access_point#policy S3AccessPoint#policy}.

publicAccessBlockConfigurationOptional 
public readonly publicAccessBlockConfiguration: S3AccessPointPublicAccessBlockConfiguration;

public_access_block_configuration block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/s3_access_point#public_access_block_configuration S3AccessPoint#public_access_block_configuration}

vpcConfigurationOptional 
public readonly vpcConfiguration: S3AccessPointVpcConfiguration;

vpc_configuration block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/s3_access_point#vpc_configuration S3AccessPoint#vpc_configuration}

S3AccessPointPublicAccessBlockConfiguration

Initializer 

import { s3AccessPoint } from '@cdktf/aws-cdk'

const s3AccessPointPublicAccessBlockConfiguration: s3AccessPoint.S3AccessPointPublicAccessBlockConfiguration = { ... }

Properties

Name Type Description
blockPublicAcls boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/s3_access_point#block_public_acls S3AccessPoint#block_public_acls}.
blockPublicPolicy boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/s3_access_point#block_public_policy S3AccessPoint#block_public_policy}.
ignorePublicAcls boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/s3_access_point#ignore_public_acls S3AccessPoint#ignore_public_acls}.
restrictPublicBuckets boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/s3_access_point#restrict_public_buckets S3AccessPoint#restrict_public_buckets}.
blockPublicAclsOptional 
public readonly blockPublicAcls: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/s3_access_point#block_public_acls S3AccessPoint#block_public_acls}.

blockPublicPolicyOptional 
public readonly blockPublicPolicy: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/s3_access_point#block_public_policy S3AccessPoint#block_public_policy}.

ignorePublicAclsOptional 
public readonly ignorePublicAcls: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/s3_access_point#ignore_public_acls S3AccessPoint#ignore_public_acls}.

restrictPublicBucketsOptional 
public readonly restrictPublicBuckets: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/s3_access_point#restrict_public_buckets S3AccessPoint#restrict_public_buckets}.

S3AccessPointVpcConfiguration

Initializer 

import { s3AccessPoint } from '@cdktf/aws-cdk'

const s3AccessPointVpcConfiguration: s3AccessPoint.S3AccessPointVpcConfiguration = { ... }

Properties

Name Type Description
vpcId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/s3_access_point#vpc_id S3AccessPoint#vpc_id}.
vpcIdRequired 
public readonly vpcId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/s3_access_point#vpc_id S3AccessPoint#vpc_id}.

Classes

S3AccessPointPublicAccessBlockConfigurationOutputReference

Initializers 

import { s3AccessPoint } from '@cdktf/aws-cdk'

new s3AccessPoint.S3AccessPointPublicAccessBlockConfigurationOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
resetBlockPublicAcls No description.
resetBlockPublicPolicy No description.
resetIgnorePublicAcls No description.
resetRestrictPublicBuckets No description.
computeFqn 
public computeFqn(): string
getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetBlockPublicAcls 
public resetBlockPublicAcls(): void
resetBlockPublicPolicy 
public resetBlockPublicPolicy(): void
resetIgnorePublicAcls 
public resetIgnorePublicAcls(): void
resetRestrictPublicBuckets 
public resetRestrictPublicBuckets(): void

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
blockPublicAclsInput boolean | cdktf.IResolvable No description.
blockPublicPolicyInput boolean | cdktf.IResolvable No description.
ignorePublicAclsInput boolean | cdktf.IResolvable No description.
restrictPublicBucketsInput boolean | cdktf.IResolvable No description.
blockPublicAcls boolean | cdktf.IResolvable No description.
blockPublicPolicy boolean | cdktf.IResolvable No description.
ignorePublicAcls boolean | cdktf.IResolvable No description.
restrictPublicBuckets boolean | cdktf.IResolvable No description.
internalValue S3AccessPointPublicAccessBlockConfiguration No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public readonly fqn: string;
  • Type: string
blockPublicAclsInputOptional 
public readonly blockPublicAclsInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
blockPublicPolicyInputOptional 
public readonly blockPublicPolicyInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
ignorePublicAclsInputOptional 
public readonly ignorePublicAclsInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
restrictPublicBucketsInputOptional 
public readonly restrictPublicBucketsInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
blockPublicAclsRequired 
public readonly blockPublicAcls: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
blockPublicPolicyRequired 
public readonly blockPublicPolicy: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
ignorePublicAclsRequired 
public readonly ignorePublicAcls: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
restrictPublicBucketsRequired 
public readonly restrictPublicBuckets: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
internalValueOptional 
public readonly internalValue: S3AccessPointPublicAccessBlockConfiguration;

S3AccessPointVpcConfigurationOutputReference

Initializers 

import { s3AccessPoint } from '@cdktf/aws-cdk'

new s3AccessPoint.S3AccessPointVpcConfigurationOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

Methods

Name Description
computeFqn No description.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
interpolationForAttribute No description.
resolve Produce the Token's value at resolution time.
toString Return a string representation of this resolvable object.
computeFqn 
public computeFqn(): string
getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • Type: cdktf.IResolveContext
toString 
public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name Type Description
creationStack string[] The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn string No description.
vpcIdInput string No description.
vpcId string No description.
internalValue S3AccessPointVpcConfiguration No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public readonly fqn: string;
  • Type: string
vpcIdInputOptional 
public readonly vpcIdInput: string;
  • Type: string
vpcIdRequired 
public readonly vpcId: string;
  • Type: string
internalValueOptional 
public readonly internalValue: S3AccessPointVpcConfiguration;