Skip to content

Latest commit

 

History

History
1622 lines (1017 loc) · 57.8 KB

eip.md

File metadata and controls

1622 lines (1017 loc) · 57.8 KB

aws_eip

Refer to the Terraform Registory for docs: aws_eip.

eip Submodule

Constructs

Eip

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

Initializers 

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

new eip.Eip(scope: Construct, id: string, config?: EipConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config EipConfig 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

configOptional

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.
putTimeouts No description.
resetAddress No description.
resetAssociateWithPrivateIp No description.
resetCustomerOwnedIpv4Pool No description.
resetId No description.
resetInstance No description.
resetNetworkBorderGroup No description.
resetNetworkInterface No description.
resetPublicIpv4Pool No description.
resetTags No description.
resetTagsAll No description.
resetTimeouts No description.
resetVpc 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
putTimeouts 
public putTimeouts(value: EipTimeouts): void
valueRequired
resetAddress 
public resetAddress(): void
resetAssociateWithPrivateIp 
public resetAssociateWithPrivateIp(): void
resetCustomerOwnedIpv4Pool 
public resetCustomerOwnedIpv4Pool(): void
resetId 
public resetId(): void
resetInstance 
public resetInstance(): void
resetNetworkBorderGroup 
public resetNetworkBorderGroup(): void
resetNetworkInterface 
public resetNetworkInterface(): void
resetPublicIpv4Pool 
public resetPublicIpv4Pool(): void
resetTags 
public resetTags(): void
resetTagsAll 
public resetTagsAll(): void
resetTimeouts 
public resetTimeouts(): void
resetVpc 
public resetVpc(): void

Static Functions

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

eip.Eip.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 { eip } from '@cdktf/aws-cdk'

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

eip.Eip.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.
allocationId string No description.
associationId string No description.
carrierIp string No description.
customerOwnedIp string No description.
domain string No description.
privateDns string No description.
privateIp string No description.
publicDns string No description.
publicIp string No description.
timeouts EipTimeoutsOutputReference No description.
addressInput string No description.
associateWithPrivateIpInput string No description.
customerOwnedIpv4PoolInput string No description.
idInput string No description.
instanceInput string No description.
networkBorderGroupInput string No description.
networkInterfaceInput string No description.
publicIpv4PoolInput string No description.
tagsAllInput {[ key: string ]: string} No description.
tagsInput {[ key: string ]: string} No description.
timeoutsInput cdktf.IResolvable | EipTimeouts No description.
vpcInput boolean | cdktf.IResolvable No description.
address string No description.
associateWithPrivateIp string No description.
customerOwnedIpv4Pool string No description.
id string No description.
instance string No description.
networkBorderGroup string No description.
networkInterface string No description.
publicIpv4Pool string No description.
tags {[ key: string ]: string} No description.
tagsAll {[ key: string ]: string} No description.
vpc boolean | cdktf.IResolvable 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[]
allocationIdRequired 
public readonly allocationId: string;
  • Type: string
associationIdRequired 
public readonly associationId: string;
  • Type: string
carrierIpRequired 
public readonly carrierIp: string;
  • Type: string
customerOwnedIpRequired 
public readonly customerOwnedIp: string;
  • Type: string
domainRequired 
public readonly domain: string;
  • Type: string
privateDnsRequired 
public readonly privateDns: string;
  • Type: string
privateIpRequired 
public readonly privateIp: string;
  • Type: string
publicDnsRequired 
public readonly publicDns: string;
  • Type: string
publicIpRequired 
public readonly publicIp: string;
  • Type: string
timeoutsRequired 
public readonly timeouts: EipTimeoutsOutputReference;
addressInputOptional 
public readonly addressInput: string;
  • Type: string
associateWithPrivateIpInputOptional 
public readonly associateWithPrivateIpInput: string;
  • Type: string
customerOwnedIpv4PoolInputOptional 
public readonly customerOwnedIpv4PoolInput: string;
  • Type: string
idInputOptional 
public readonly idInput: string;
  • Type: string
instanceInputOptional 
public readonly instanceInput: string;
  • Type: string
networkBorderGroupInputOptional 
public readonly networkBorderGroupInput: string;
  • Type: string
networkInterfaceInputOptional 
public readonly networkInterfaceInput: string;
  • Type: string
publicIpv4PoolInputOptional 
public readonly publicIpv4PoolInput: string;
  • Type: string
tagsAllInputOptional 
public readonly tagsAllInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsInputOptional 
public readonly tagsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
timeoutsInputOptional 
public readonly timeoutsInput: IResolvable | EipTimeouts;
vpcInputOptional 
public readonly vpcInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
addressRequired 
public readonly address: string;
  • Type: string
associateWithPrivateIpRequired 
public readonly associateWithPrivateIp: string;
  • Type: string
customerOwnedIpv4PoolRequired 
public readonly customerOwnedIpv4Pool: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
instanceRequired 
public readonly instance: string;
  • Type: string
networkBorderGroupRequired 
public readonly networkBorderGroup: string;
  • Type: string
networkInterfaceRequired 
public readonly networkInterface: string;
  • Type: string
publicIpv4PoolRequired 
public readonly publicIpv4Pool: string;
  • Type: string
tagsRequired 
public readonly tags: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
tagsAllRequired 
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
vpcRequired 
public readonly vpc: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Constants

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

Structs

EipConfig

Initializer 

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

const eipConfig: eip.EipConfig = { ... }

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.
address string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/eip#address Eip#address}.
associateWithPrivateIp string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/eip#associate_with_private_ip Eip#associate_with_private_ip}.
customerOwnedIpv4Pool string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/eip#customer_owned_ipv4_pool Eip#customer_owned_ipv4_pool}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/eip#id Eip#id}.
instance string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/eip#instance Eip#instance}.
networkBorderGroup string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/eip#network_border_group Eip#network_border_group}.
networkInterface string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/eip#network_interface Eip#network_interface}.
publicIpv4Pool string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/eip#public_ipv4_pool Eip#public_ipv4_pool}.
tags {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/eip#tags Eip#tags}.
tagsAll {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/eip#tags_all Eip#tags_all}.
timeouts EipTimeouts timeouts block.
vpc boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/eip#vpc Eip#vpc}.
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[]
addressOptional 
public readonly address: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/eip#address Eip#address}.

associateWithPrivateIpOptional 
public readonly associateWithPrivateIp: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/eip#associate_with_private_ip Eip#associate_with_private_ip}.

customerOwnedIpv4PoolOptional 
public readonly customerOwnedIpv4Pool: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/eip#customer_owned_ipv4_pool Eip#customer_owned_ipv4_pool}.

idOptional 
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/eip#id Eip#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.

instanceOptional 
public readonly instance: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/eip#instance Eip#instance}.

networkBorderGroupOptional 
public readonly networkBorderGroup: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/eip#network_border_group Eip#network_border_group}.

networkInterfaceOptional 
public readonly networkInterface: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/eip#network_interface Eip#network_interface}.

publicIpv4PoolOptional 
public readonly publicIpv4Pool: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/eip#public_ipv4_pool Eip#public_ipv4_pool}.

tagsOptional 
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/resources/eip#tags Eip#tags}.

tagsAllOptional 
public readonly tagsAll: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/eip#tags_all Eip#tags_all}.

timeoutsOptional 
public readonly timeouts: EipTimeouts;

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/eip#timeouts Eip#timeouts}

vpcOptional 
public readonly vpc: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/eip#vpc Eip#vpc}.

EipTimeouts

Initializer 

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

const eipTimeouts: eip.EipTimeouts = { ... }

Properties

Name Type Description
delete string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/eip#delete Eip#delete}.
read string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/eip#read Eip#read}.
update string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/eip#update Eip#update}.
deleteOptional 
public readonly delete: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/eip#delete Eip#delete}.

readOptional 
public readonly read: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/eip#read Eip#read}.

updateOptional 
public readonly update: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/eip#update Eip#update}.

Classes

EipTimeoutsOutputReference

Initializers 

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

new eip.EipTimeoutsOutputReference(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.
resetDelete No description.
resetRead No description.
resetUpdate 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.

resetDelete 
public resetDelete(): void
resetRead 
public resetRead(): void
resetUpdate 
public resetUpdate(): 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.
deleteInput string No description.
readInput string No description.
updateInput string No description.
delete string No description.
read string No description.
update string No description.
internalValue cdktf.IResolvable | EipTimeouts 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
deleteInputOptional 
public readonly deleteInput: string;
  • Type: string
readInputOptional 
public readonly readInput: string;
  • Type: string
updateInputOptional 
public readonly updateInput: string;
  • Type: string
deleteRequired 
public readonly delete: string;
  • Type: string
readRequired 
public readonly read: string;
  • Type: string
updateRequired 
public readonly update: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | EipTimeouts;