Refer to the Terraform Registory for docs: data_aws_subnet
.
Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/subnet aws_subnet}.
import { dataAwsSubnet } from '@cdktf/aws-cdk'
new dataAwsSubnet.DataAwsSubnet(scope: Construct, id: string, config?: DataAwsSubnetConfig)
Name | Type | Description |
---|---|---|
scope |
constructs.Construct |
The scope in which to define this construct. |
id |
string |
The scoped construct ID. |
config |
DataAwsSubnetConfig |
No description. |
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: DataAwsSubnetConfig
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. |
putFilter |
No description. |
resetAvailabilityZone |
No description. |
resetAvailabilityZoneId |
No description. |
resetCidrBlock |
No description. |
resetDefaultForAz |
No description. |
resetFilter |
No description. |
resetId |
No description. |
resetIpv6CidrBlock |
No description. |
resetState |
No description. |
resetTags |
No description. |
resetVpcId |
No description. |
public toString(): string
Returns a string representation of this construct.
public addOverride(path: string, value: any): void
- Type: string
- Type: any
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
public toMetadata(): any
public toTerraform(): any
Adds this resource to the terraform JSON output.
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable
- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
- Type: string
public getListAttribute(terraformAttribute: string): string[]
- Type: string
public getNumberAttribute(terraformAttribute: string): number
- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]
- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
- Type: string
public getStringAttribute(terraformAttribute: string): string
- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
- Type: string
public interpolationForAttribute(terraformAttribute: string): IResolvable
- Type: string
public putFilter(value: IResolvable | DataAwsSubnetFilter[]): void
- Type: cdktf.IResolvable | DataAwsSubnetFilter[]
public resetAvailabilityZone(): void
public resetAvailabilityZoneId(): void
public resetCidrBlock(): void
public resetDefaultForAz(): void
public resetFilter(): void
public resetId(): void
public resetIpv6CidrBlock(): void
public resetState(): void
public resetTags(): void
public resetVpcId(): void
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
isTerraformElement |
No description. |
isTerraformDataSource |
No description. |
import { dataAwsSubnet } from '@cdktf/aws-cdk'
dataAwsSubnet.DataAwsSubnet.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.
- Type: any
Any object.
import { dataAwsSubnet } from '@cdktf/aws-cdk'
dataAwsSubnet.DataAwsSubnet.isTerraformElement(x: any)
- Type: any
import { dataAwsSubnet } from '@cdktf/aws-cdk'
dataAwsSubnet.DataAwsSubnet.isTerraformDataSource(x: any)
- Type: any
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. |
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. |
arn |
string |
No description. |
assignIpv6AddressOnCreation |
cdktf.IResolvable |
No description. |
availableIpAddressCount |
number |
No description. |
customerOwnedIpv4Pool |
string |
No description. |
enableDns64 |
cdktf.IResolvable |
No description. |
enableResourceNameDnsAaaaRecordOnLaunch |
cdktf.IResolvable |
No description. |
enableResourceNameDnsARecordOnLaunch |
cdktf.IResolvable |
No description. |
filter |
DataAwsSubnetFilterList |
No description. |
ipv6CidrBlockAssociationId |
string |
No description. |
ipv6Native |
cdktf.IResolvable |
No description. |
mapCustomerOwnedIpOnLaunch |
cdktf.IResolvable |
No description. |
mapPublicIpOnLaunch |
cdktf.IResolvable |
No description. |
outpostArn |
string |
No description. |
ownerId |
string |
No description. |
privateDnsHostnameTypeOnLaunch |
string |
No description. |
availabilityZoneIdInput |
string |
No description. |
availabilityZoneInput |
string |
No description. |
cidrBlockInput |
string |
No description. |
defaultForAzInput |
boolean | cdktf.IResolvable |
No description. |
filterInput |
cdktf.IResolvable | DataAwsSubnetFilter[] |
No description. |
idInput |
string |
No description. |
ipv6CidrBlockInput |
string |
No description. |
stateInput |
string |
No description. |
tagsInput |
{[ key: string ]: string} |
No description. |
vpcIdInput |
string |
No description. |
availabilityZone |
string |
No description. |
availabilityZoneId |
string |
No description. |
cidrBlock |
string |
No description. |
defaultForAz |
boolean | cdktf.IResolvable |
No description. |
id |
string |
No description. |
ipv6CidrBlock |
string |
No description. |
state |
string |
No description. |
tags |
{[ key: string ]: string} |
No description. |
vpcId |
string |
No description. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
public readonly cdktfStack: TerraformStack;
- Type: cdktf.TerraformStack
public readonly fqn: string;
- Type: string
public readonly friendlyUniqueId: string;
- Type: string
public readonly terraformMetaArguments: {[ key: string ]: any};
- Type: {[ key: string ]: any}
public readonly terraformResourceType: string;
- Type: string
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
- Type: cdktf.TerraformProviderGeneratorMetadata
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: string[];
- Type: string[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly arn: string;
- Type: string
public readonly assignIpv6AddressOnCreation: IResolvable;
- Type: cdktf.IResolvable
public readonly availableIpAddressCount: number;
- Type: number
public readonly customerOwnedIpv4Pool: string;
- Type: string
public readonly enableDns64: IResolvable;
- Type: cdktf.IResolvable
public readonly enableResourceNameDnsAaaaRecordOnLaunch: IResolvable;
- Type: cdktf.IResolvable
public readonly enableResourceNameDnsARecordOnLaunch: IResolvable;
- Type: cdktf.IResolvable
public readonly filter: DataAwsSubnetFilterList;
- Type: DataAwsSubnetFilterList
public readonly ipv6CidrBlockAssociationId: string;
- Type: string
public readonly ipv6Native: IResolvable;
- Type: cdktf.IResolvable
public readonly mapCustomerOwnedIpOnLaunch: IResolvable;
- Type: cdktf.IResolvable
public readonly mapPublicIpOnLaunch: IResolvable;
- Type: cdktf.IResolvable
public readonly outpostArn: string;
- Type: string
public readonly ownerId: string;
- Type: string
public readonly privateDnsHostnameTypeOnLaunch: string;
- Type: string
public readonly availabilityZoneIdInput: string;
- Type: string
public readonly availabilityZoneInput: string;
- Type: string
public readonly cidrBlockInput: string;
- Type: string
public readonly defaultForAzInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly filterInput: IResolvable | DataAwsSubnetFilter[];
- Type: cdktf.IResolvable | DataAwsSubnetFilter[]
public readonly idInput: string;
- Type: string
public readonly ipv6CidrBlockInput: string;
- Type: string
public readonly stateInput: string;
- Type: string
public readonly tagsInput: {[ key: string ]: string};
- Type: {[ key: string ]: string}
public readonly vpcIdInput: string;
- Type: string
public readonly availabilityZone: string;
- Type: string
public readonly availabilityZoneId: string;
- Type: string
public readonly cidrBlock: string;
- Type: string
public readonly defaultForAz: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly id: string;
- Type: string
public readonly ipv6CidrBlock: string;
- Type: string
public readonly state: string;
- Type: string
public readonly tags: {[ key: string ]: string};
- Type: {[ key: string ]: string}
public readonly vpcId: string;
- Type: string
Name | Type | Description |
---|---|---|
tfResourceType |
string |
No description. |
public readonly tfResourceType: string;
- Type: string
import { dataAwsSubnet } from '@cdktf/aws-cdk'
const dataAwsSubnetConfig: dataAwsSubnet.DataAwsSubnetConfig = { ... }
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. |
availabilityZone |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/subnet#availability_zone DataAwsSubnet#availability_zone}. |
availabilityZoneId |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/subnet#availability_zone_id DataAwsSubnet#availability_zone_id}. |
cidrBlock |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/subnet#cidr_block DataAwsSubnet#cidr_block}. |
defaultForAz |
boolean | cdktf.IResolvable |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/subnet#default_for_az DataAwsSubnet#default_for_az}. |
filter |
cdktf.IResolvable | DataAwsSubnetFilter[] |
filter block. |
id |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/subnet#id DataAwsSubnet#id}. |
ipv6CidrBlock |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/subnet#ipv6_cidr_block DataAwsSubnet#ipv6_cidr_block}. |
state |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/subnet#state DataAwsSubnet#state}. |
tags |
{[ key: string ]: string} |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/subnet#tags DataAwsSubnet#tags}. |
vpcId |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/subnet#vpc_id DataAwsSubnet#vpc_id}. |
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: ITerraformDependable[];
- Type: cdktf.ITerraformDependable[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly availabilityZone: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/subnet#availability_zone DataAwsSubnet#availability_zone}.
public readonly availabilityZoneId: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/subnet#availability_zone_id DataAwsSubnet#availability_zone_id}.
public readonly cidrBlock: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/subnet#cidr_block DataAwsSubnet#cidr_block}.
public readonly defaultForAz: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/subnet#default_for_az DataAwsSubnet#default_for_az}.
public readonly filter: IResolvable | DataAwsSubnetFilter[];
- Type: cdktf.IResolvable | DataAwsSubnetFilter[]
filter block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/subnet#filter DataAwsSubnet#filter}
public readonly id: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/subnet#id DataAwsSubnet#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.
public readonly ipv6CidrBlock: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/subnet#ipv6_cidr_block DataAwsSubnet#ipv6_cidr_block}.
public readonly state: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/subnet#state DataAwsSubnet#state}.
public readonly tags: {[ key: string ]: string};
- Type: {[ key: string ]: string}
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/subnet#tags DataAwsSubnet#tags}.
public readonly vpcId: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/subnet#vpc_id DataAwsSubnet#vpc_id}.
import { dataAwsSubnet } from '@cdktf/aws-cdk'
const dataAwsSubnetFilter: dataAwsSubnet.DataAwsSubnetFilter = { ... }
Name | Type | Description |
---|---|---|
name |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/subnet#name DataAwsSubnet#name}. |
values |
string[] |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/subnet#values DataAwsSubnet#values}. |
public readonly name: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/subnet#name DataAwsSubnet#name}.
public readonly values: string[];
- Type: string[]
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/data-sources/subnet#values DataAwsSubnet#values}.
import { dataAwsSubnet } from '@cdktf/aws-cdk'
new dataAwsSubnet.DataAwsSubnetFilterList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)
Name | Type | Description |
---|---|---|
terraformResource |
cdktf.IInterpolatingParent |
The parent resource. |
terraformAttribute |
string |
The attribute on the parent resource this class is referencing. |
wrapsSet |
boolean |
whether the list is wrapping a set (will add tolist() to be able to access an item via an index). |
- Type: cdktf.IInterpolatingParent
The parent resource.
- Type: string
The attribute on the parent resource this class is referencing.
- Type: boolean
whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
Name | Description |
---|---|
computeFqn |
No description. |
resolve |
Produce the Token's value at resolution time. |
toString |
Return a string representation of this resolvable object. |
get |
No description. |
public computeFqn(): string
public resolve(_context: IResolveContext): any
Produce the Token's value at resolution time.
- Type: cdktf.IResolveContext
public toString(): string
Return a string representation of this resolvable object.
Returns a reversible string representation.
public get(index: number): DataAwsSubnetFilterOutputReference
- Type: number
the index of the item to return.
Name | Type | Description |
---|---|---|
creationStack |
string[] |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
string |
No description. |
internalValue |
cdktf.IResolvable | DataAwsSubnetFilter[] |
No description. |
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.
public readonly fqn: string;
- Type: string
public readonly internalValue: IResolvable | DataAwsSubnetFilter[];
- Type: cdktf.IResolvable | DataAwsSubnetFilter[]
import { dataAwsSubnet } from '@cdktf/aws-cdk'
new dataAwsSubnet.DataAwsSubnetFilterOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)
Name | Type | Description |
---|---|---|
terraformResource |
cdktf.IInterpolatingParent |
The parent resource. |
terraformAttribute |
string |
The attribute on the parent resource this class is referencing. |
complexObjectIndex |
number |
the index of this item in the list. |
complexObjectIsFromSet |
boolean |
whether the list is wrapping a set (will add tolist() to be able to access an item via an index). |
- Type: cdktf.IInterpolatingParent
The parent resource.
- Type: string
The attribute on the parent resource this class is referencing.
- Type: number
the index of this item in the list.
- Type: boolean
whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
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. |
public computeFqn(): string
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable
- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
- Type: string
public getListAttribute(terraformAttribute: string): string[]
- Type: string
public getNumberAttribute(terraformAttribute: string): number
- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]
- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
- Type: string
public getStringAttribute(terraformAttribute: string): string
- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
- Type: string
public interpolationForAttribute(property: string): IResolvable
- Type: string
public resolve(_context: IResolveContext): any
Produce the Token's value at resolution time.
- Type: cdktf.IResolveContext
public toString(): string
Return a string representation of this resolvable object.
Returns a reversible string representation.
Name | Type | Description |
---|---|---|
creationStack |
string[] |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
string |
No description. |
nameInput |
string |
No description. |
valuesInput |
string[] |
No description. |
name |
string |
No description. |
values |
string[] |
No description. |
internalValue |
cdktf.IResolvable | DataAwsSubnetFilter |
No description. |
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.
public readonly fqn: string;
- Type: string
public readonly nameInput: string;
- Type: string
public readonly valuesInput: string[];
- Type: string[]
public readonly name: string;
- Type: string
public readonly values: string[];
- Type: string[]
public readonly internalValue: IResolvable | DataAwsSubnetFilter;
- Type: cdktf.IResolvable | DataAwsSubnetFilter