`apiGatewayDomainName` Submodule

Constructs

ApiGatewayDomainName

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

Initializers

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

new apiGatewayDomainName.ApiGatewayDomainName(scope: Construct, id: string, config: ApiGatewayDomainNameConfig)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.
`config`	`ApiGatewayDomainNameConfig`	No description.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

`config`^Required

Type: ApiGatewayDomainNameConfig

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.
`toHclTerraform`	No description.
`toMetadata`	No description.
`toTerraform`	Adds this resource to the terraform JSON output.
`addMoveTarget`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`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.
`hasResourceMove`	No description.
`importFrom`	No description.
`interpolationForAttribute`	No description.
`moveFromId`	Move the resource corresponding to "id" to this resource.
`moveTo`	Moves this resource to the target resource given by moveTarget.
`moveToId`	Moves this resource to the resource corresponding to "id".
`putEndpointConfiguration`	No description.
`putMutualTlsAuthentication`	No description.
`resetCertificateArn`	No description.
`resetCertificateBody`	No description.
`resetCertificateChain`	No description.
`resetCertificateName`	No description.
`resetCertificatePrivateKey`	No description.
`resetEndpointConfiguration`	No description.
`resetId`	No description.
`resetMutualTlsAuthentication`	No description.
`resetRegionalCertificateArn`	No description.
`resetRegionalCertificateName`	No description.
`resetSecurityPolicy`	No description.
`resetTags`	No description.
`resetTagsAll`	No description.

`toString`

public toString(): string

Returns a string representation of this construct.

`addOverride`

public addOverride(path: string, value: any): void

`path`^Required

Type: string

`value`^Required

Type: any

`overrideLogicalId`

public overrideLogicalId(newLogicalId: string): void

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

`newLogicalId`^Required

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.

`toHclTerraform`

public toHclTerraform(): any

`toMetadata`

public toMetadata(): any

`toTerraform`

public toTerraform(): any

Adds this resource to the terraform JSON output.

`addMoveTarget`

public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

`moveTarget`^Required

Type: string

The string move target that will correspond to this resource.

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`hasResourceMove`

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

`importFrom`

public importFrom(id: string, provider?: TerraformProvider): void

`id`^Required

Type: string

`provider`^Optional

Type: cdktf.TerraformProvider

`interpolationForAttribute`

public interpolationForAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`moveFromId`

public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

`id`^Required

Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

`moveTo`

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

`moveTarget`^Required

Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

`index`^Optional

Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

`moveToId`

public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

`id`^Required

Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

`putEndpointConfiguration`

public putEndpointConfiguration(value: ApiGatewayDomainNameEndpointConfiguration): void

`value`^Required

Type: ApiGatewayDomainNameEndpointConfiguration

`putMutualTlsAuthentication`

public putMutualTlsAuthentication(value: ApiGatewayDomainNameMutualTlsAuthentication): void

`value`^Required

Type: ApiGatewayDomainNameMutualTlsAuthentication

`resetCertificateArn`

public resetCertificateArn(): void

`resetCertificateBody`

public resetCertificateBody(): void

`resetCertificateChain`

public resetCertificateChain(): void

`resetCertificateName`

public resetCertificateName(): void

`resetCertificatePrivateKey`

public resetCertificatePrivateKey(): void

`resetEndpointConfiguration`

public resetEndpointConfiguration(): void

`resetId`

public resetId(): void

`resetMutualTlsAuthentication`

public resetMutualTlsAuthentication(): void

`resetRegionalCertificateArn`

public resetRegionalCertificateArn(): void

`resetRegionalCertificateName`

public resetRegionalCertificateName(): void

`resetSecurityPolicy`

public resetSecurityPolicy(): void

`resetTags`

public resetTags(): void

`resetTagsAll`

public resetTagsAll(): void

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isTerraformElement`	No description.
`isTerraformResource`	No description.
`generateConfigForImport`	Generates CDKTF code for importing a ApiGatewayDomainName resource upon running "cdktf plan ".

`isConstruct`

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

apiGatewayDomainName.ApiGatewayDomainName.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.

`x`^Required

Type: any

Any object.

`isTerraformElement`

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

apiGatewayDomainName.ApiGatewayDomainName.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

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

apiGatewayDomainName.ApiGatewayDomainName.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

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

apiGatewayDomainName.ApiGatewayDomainName.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a ApiGatewayDomainName resource upon running "cdktf plan ".

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`importToId`^Required

Type: string

The construct id used in the generated config for the ApiGatewayDomainName to import.

`importFromId`^Required

Type: string

The id of the existing ApiGatewayDomainName that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_domain_name#import import section} in the documentation of this resource for the id to use

`provider`^Optional

Type: cdktf.TerraformProvider

? Optional instance of the provider where the ApiGatewayDomainName to import is found.

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.
`arn`	`string`	No description.
`certificateUploadDate`	`string`	No description.
`cloudfrontDomainName`	`string`	No description.
`cloudfrontZoneId`	`string`	No description.
`endpointConfiguration`	`ApiGatewayDomainNameEndpointConfigurationOutputReference`	No description.
`mutualTlsAuthentication`	`ApiGatewayDomainNameMutualTlsAuthenticationOutputReference`	No description.
`regionalDomainName`	`string`	No description.
`regionalZoneId`	`string`	No description.
`certificateArnInput`	`string`	No description.
`certificateBodyInput`	`string`	No description.
`certificateChainInput`	`string`	No description.
`certificateNameInput`	`string`	No description.
`certificatePrivateKeyInput`	`string`	No description.
`domainNameInput`	`string`	No description.
`endpointConfigurationInput`	`ApiGatewayDomainNameEndpointConfiguration`	No description.
`idInput`	`string`	No description.
`mutualTlsAuthenticationInput`	`ApiGatewayDomainNameMutualTlsAuthentication`	No description.
`regionalCertificateArnInput`	`string`	No description.
`regionalCertificateNameInput`	`string`	No description.
`securityPolicyInput`	`string`	No description.
`tagsAllInput`	`{[ key: string ]: string}`	No description.
`tagsInput`	`{[ key: string ]: string}`	No description.
`certificateArn`	`string`	No description.
`certificateBody`	`string`	No description.
`certificateChain`	`string`	No description.
`certificateName`	`string`	No description.
`certificatePrivateKey`	`string`	No description.
`domainName`	`string`	No description.
`id`	`string`	No description.
`regionalCertificateArn`	`string`	No description.
`regionalCertificateName`	`string`	No description.
`securityPolicy`	`string`	No description.
`tags`	`{[ key: string ]: string}`	No description.
`tagsAll`	`{[ key: string ]: string}`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`cdktfStack`^Required

public readonly cdktfStack: TerraformStack;

Type: cdktf.TerraformStack

`fqn`^Required

public readonly fqn: string;

Type: string

`friendlyUniqueId`^Required

public readonly friendlyUniqueId: string;

Type: string

`terraformMetaArguments`^Required

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

Type: {[ key: string ]: any}

`terraformResourceType`^Required

public readonly terraformResourceType: string;

Type: string

`terraformGeneratorMetadata`^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

Type: cdktf.TerraformProviderGeneratorMetadata

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: string[];

Type: string[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`arn`^Required

public readonly arn: string;

Type: string

`certificateUploadDate`^Required

public readonly certificateUploadDate: string;

Type: string

`cloudfrontDomainName`^Required

public readonly cloudfrontDomainName: string;

Type: string

`cloudfrontZoneId`^Required

public readonly cloudfrontZoneId: string;

Type: string

`endpointConfiguration`^Required

public readonly endpointConfiguration: ApiGatewayDomainNameEndpointConfigurationOutputReference;

Type: ApiGatewayDomainNameEndpointConfigurationOutputReference

`mutualTlsAuthentication`^Required

public readonly mutualTlsAuthentication: ApiGatewayDomainNameMutualTlsAuthenticationOutputReference;

Type: ApiGatewayDomainNameMutualTlsAuthenticationOutputReference

`regionalDomainName`^Required

public readonly regionalDomainName: string;

Type: string

`regionalZoneId`^Required

public readonly regionalZoneId: string;

Type: string

`certificateArnInput`^Optional

public readonly certificateArnInput: string;

Type: string

`certificateBodyInput`^Optional

public readonly certificateBodyInput: string;

Type: string

`certificateChainInput`^Optional

public readonly certificateChainInput: string;

Type: string

`certificateNameInput`^Optional

public readonly certificateNameInput: string;

Type: string

`certificatePrivateKeyInput`^Optional

public readonly certificatePrivateKeyInput: string;

Type: string

`domainNameInput`^Optional

public readonly domainNameInput: string;

Type: string

`endpointConfigurationInput`^Optional

public readonly endpointConfigurationInput: ApiGatewayDomainNameEndpointConfiguration;

Type: ApiGatewayDomainNameEndpointConfiguration

`idInput`^Optional

public readonly idInput: string;

Type: string

`mutualTlsAuthenticationInput`^Optional

public readonly mutualTlsAuthenticationInput: ApiGatewayDomainNameMutualTlsAuthentication;

Type: ApiGatewayDomainNameMutualTlsAuthentication

`regionalCertificateArnInput`^Optional

public readonly regionalCertificateArnInput: string;

Type: string

`regionalCertificateNameInput`^Optional

public readonly regionalCertificateNameInput: string;

Type: string

`securityPolicyInput`^Optional

public readonly securityPolicyInput: string;

Type: string

`tagsAllInput`^Optional

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

Type: {[ key: string ]: string}

`tagsInput`^Optional

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

Type: {[ key: string ]: string}

`certificateArn`^Required

public readonly certificateArn: string;

Type: string

`certificateBody`^Required

public readonly certificateBody: string;

Type: string

`certificateChain`^Required

public readonly certificateChain: string;

Type: string

`certificateName`^Required

public readonly certificateName: string;

Type: string

`certificatePrivateKey`^Required

public readonly certificatePrivateKey: string;

Type: string

`domainName`^Required

public readonly domainName: string;

Type: string

`id`^Required

public readonly id: string;

Type: string

`regionalCertificateArn`^Required

public readonly regionalCertificateArn: string;

Type: string

`regionalCertificateName`^Required

public readonly regionalCertificateName: string;

Type: string

`securityPolicy`^Required

public readonly securityPolicy: string;

Type: string

`tags`^Required

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

Type: {[ key: string ]: string}

`tagsAll`^Required

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

Type: {[ key: string ]: string}

Constants

Name	Type	Description
`tfResourceType`	`string`	No description.

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Structs

ApiGatewayDomainNameConfig

Initializer

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

const apiGatewayDomainNameConfig: apiGatewayDomainName.ApiGatewayDomainNameConfig = { ... }

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.
`domainName`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_domain_name#domain_name ApiGatewayDomainName#domain_name}.
`certificateArn`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_domain_name#certificate_arn ApiGatewayDomainName#certificate_arn}.
`certificateBody`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_domain_name#certificate_body ApiGatewayDomainName#certificate_body}.
`certificateChain`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_domain_name#certificate_chain ApiGatewayDomainName#certificate_chain}.
`certificateName`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_domain_name#certificate_name ApiGatewayDomainName#certificate_name}.
`certificatePrivateKey`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_domain_name#certificate_private_key ApiGatewayDomainName#certificate_private_key}.
`endpointConfiguration`	`ApiGatewayDomainNameEndpointConfiguration`	endpoint_configuration block.
`id`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_domain_name#id ApiGatewayDomainName#id}.
`mutualTlsAuthentication`	`ApiGatewayDomainNameMutualTlsAuthentication`	mutual_tls_authentication block.
`regionalCertificateArn`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_domain_name#regional_certificate_arn ApiGatewayDomainName#regional_certificate_arn}.
`regionalCertificateName`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_domain_name#regional_certificate_name ApiGatewayDomainName#regional_certificate_name}.
`securityPolicy`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_domain_name#security_policy ApiGatewayDomainName#security_policy}.
`tags`	`{[ key: string ]: string}`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_domain_name#tags ApiGatewayDomainName#tags}.
`tagsAll`	`{[ key: string ]: string}`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_domain_name#tags_all ApiGatewayDomainName#tags_all}.

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | cdktf.TerraformCount

`dependsOn`^Optional

public readonly dependsOn: ITerraformDependable[];

Type: cdktf.ITerraformDependable[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: cdktf.ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: cdktf.TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: cdktf.TerraformProvider

`provisioners`^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

`domainName`^Required

public readonly domainName: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_domain_name#domain_name ApiGatewayDomainName#domain_name}.

`certificateArn`^Optional

public readonly certificateArn: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_domain_name#certificate_arn ApiGatewayDomainName#certificate_arn}.

`certificateBody`^Optional

public readonly certificateBody: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_domain_name#certificate_body ApiGatewayDomainName#certificate_body}.

`certificateChain`^Optional

public readonly certificateChain: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_domain_name#certificate_chain ApiGatewayDomainName#certificate_chain}.

`certificateName`^Optional

public readonly certificateName: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_domain_name#certificate_name ApiGatewayDomainName#certificate_name}.

`certificatePrivateKey`^Optional

public readonly certificatePrivateKey: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_domain_name#certificate_private_key ApiGatewayDomainName#certificate_private_key}.

`endpointConfiguration`^Optional

public readonly endpointConfiguration: ApiGatewayDomainNameEndpointConfiguration;

Type: ApiGatewayDomainNameEndpointConfiguration

endpoint_configuration block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_domain_name#endpoint_configuration ApiGatewayDomainName#endpoint_configuration}

`id`^Optional

public readonly id: string;

Type: string

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

`mutualTlsAuthentication`^Optional

public readonly mutualTlsAuthentication: ApiGatewayDomainNameMutualTlsAuthentication;

Type: ApiGatewayDomainNameMutualTlsAuthentication

mutual_tls_authentication block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_domain_name#mutual_tls_authentication ApiGatewayDomainName#mutual_tls_authentication}

`regionalCertificateArn`^Optional

public readonly regionalCertificateArn: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_domain_name#regional_certificate_arn ApiGatewayDomainName#regional_certificate_arn}.

`regionalCertificateName`^Optional

public readonly regionalCertificateName: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_domain_name#regional_certificate_name ApiGatewayDomainName#regional_certificate_name}.

`securityPolicy`^Optional

public readonly securityPolicy: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_domain_name#security_policy ApiGatewayDomainName#security_policy}.

`tags`^Optional

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/api_gateway_domain_name#tags ApiGatewayDomainName#tags}.

`tagsAll`^Optional

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/api_gateway_domain_name#tags_all ApiGatewayDomainName#tags_all}.

ApiGatewayDomainNameEndpointConfiguration

Initializer

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

const apiGatewayDomainNameEndpointConfiguration: apiGatewayDomainName.ApiGatewayDomainNameEndpointConfiguration = { ... }

Properties

Name	Type	Description
`types`	`string[]`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_domain_name#types ApiGatewayDomainName#types}.

`types`^Required

public readonly types: string[];

Type: string[]

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_domain_name#types ApiGatewayDomainName#types}.

ApiGatewayDomainNameMutualTlsAuthentication

Initializer

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

const apiGatewayDomainNameMutualTlsAuthentication: apiGatewayDomainName.ApiGatewayDomainNameMutualTlsAuthentication = { ... }

Properties

Name	Type	Description
`truststoreUri`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_domain_name#truststore_uri ApiGatewayDomainName#truststore_uri}.
`truststoreVersion`	`string`	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_domain_name#truststore_version ApiGatewayDomainName#truststore_version}.

`truststoreUri`^Required

public readonly truststoreUri: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_domain_name#truststore_uri ApiGatewayDomainName#truststore_uri}.

`truststoreVersion`^Optional

public readonly truststoreVersion: string;

Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_domain_name#truststore_version ApiGatewayDomainName#truststore_version}.

Classes

ApiGatewayDomainNameEndpointConfigurationOutputReference

Initializers

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

new apiGatewayDomainName.ApiGatewayDomainNameEndpointConfigurationOutputReference(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.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

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}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

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.
`typesInput`	`string[]`	No description.
`types`	`string[]`	No description.
`internalValue`	`ApiGatewayDomainNameEndpointConfiguration`	No description.

`creationStack`^Required

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.

`fqn`^Required

public readonly fqn: string;

Type: string

`typesInput`^Optional

public readonly typesInput: string[];

Type: string[]

`types`^Required

public readonly types: string[];

Type: string[]

`internalValue`^Optional

public readonly internalValue: ApiGatewayDomainNameEndpointConfiguration;

Type: ApiGatewayDomainNameEndpointConfiguration

ApiGatewayDomainNameMutualTlsAuthenticationOutputReference

Initializers

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

new apiGatewayDomainName.ApiGatewayDomainNameMutualTlsAuthenticationOutputReference(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.

`terraformResource`^Required

Type: cdktf.IInterpolatingParent

The parent resource.

`terraformAttribute`^Required

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.
`resetTruststoreVersion`	No description.

`computeFqn`

public computeFqn(): string

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(property: string): IResolvable

`property`^Required

Type: string

`resolve`

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

`_context`^Required

Type: cdktf.IResolveContext

`toString`

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

`resetTruststoreVersion`

public resetTruststoreVersion(): 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.
`truststoreUriInput`	`string`	No description.
`truststoreVersionInput`	`string`	No description.
`truststoreUri`	`string`	No description.
`truststoreVersion`	`string`	No description.
`internalValue`	`ApiGatewayDomainNameMutualTlsAuthentication`	No description.

`creationStack`^Required

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.

`fqn`^Required

public readonly fqn: string;

Type: string

`truststoreUriInput`^Optional

public readonly truststoreUriInput: string;

Type: string

`truststoreVersionInput`^Optional

public readonly truststoreVersionInput: string;

Type: string

`truststoreUri`^Required

public readonly truststoreUri: string;

Type: string

`truststoreVersion`^Required

public readonly truststoreVersion: string;

Type: string

`internalValue`^Optional

public readonly internalValue: ApiGatewayDomainNameMutualTlsAuthentication;

Type: ApiGatewayDomainNameMutualTlsAuthentication

Uh oh!

FilesExpand file tree

apiGatewayDomainName.md

Latest commit

History

apiGatewayDomainName.md

File metadata and controls

apiGatewayDomainName Submodule

Constructs