Skip to content

Latest commit

 

History

History
1933 lines (1205 loc) · 89.7 KB

apiGatewayDomainName.md

File metadata and controls

1933 lines (1205 loc) · 89.7 KB

aws_api_gateway_domain_name

Refer to the Terraform Registory for docs: aws_api_gateway_domain_name.

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.

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

putEndpointConfiguration
public putEndpointConfiguration(value: ApiGatewayDomainNameEndpointConfiguration): void
valueRequired

putMutualTlsAuthentication
public putMutualTlsAuthentication(value: ApiGatewayDomainNameMutualTlsAuthentication): void
valueRequired

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.

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.

xRequired
  • Type: any

Any object.


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

apiGatewayDomainName.ApiGatewayDomainName.isTerraformElement(x: any)
xRequired
  • Type: any

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

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

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[]

arnRequired
public readonly arn: string;
  • Type: string

certificateUploadDateRequired
public readonly certificateUploadDate: string;
  • Type: string

cloudfrontDomainNameRequired
public readonly cloudfrontDomainName: string;
  • Type: string

cloudfrontZoneIdRequired
public readonly cloudfrontZoneId: string;
  • Type: string

endpointConfigurationRequired
public readonly endpointConfiguration: ApiGatewayDomainNameEndpointConfigurationOutputReference;

mutualTlsAuthenticationRequired
public readonly mutualTlsAuthentication: ApiGatewayDomainNameMutualTlsAuthenticationOutputReference;

regionalDomainNameRequired
public readonly regionalDomainName: string;
  • Type: string

regionalZoneIdRequired
public readonly regionalZoneId: string;
  • Type: string

certificateArnInputOptional
public readonly certificateArnInput: string;
  • Type: string

certificateBodyInputOptional
public readonly certificateBodyInput: string;
  • Type: string

certificateChainInputOptional
public readonly certificateChainInput: string;
  • Type: string

certificateNameInputOptional
public readonly certificateNameInput: string;
  • Type: string

certificatePrivateKeyInputOptional
public readonly certificatePrivateKeyInput: string;
  • Type: string

domainNameInputOptional
public readonly domainNameInput: string;
  • Type: string

endpointConfigurationInputOptional
public readonly endpointConfigurationInput: ApiGatewayDomainNameEndpointConfiguration;

idInputOptional
public readonly idInput: string;
  • Type: string

mutualTlsAuthenticationInputOptional
public readonly mutualTlsAuthenticationInput: ApiGatewayDomainNameMutualTlsAuthentication;

regionalCertificateArnInputOptional
public readonly regionalCertificateArnInput: string;
  • Type: string

regionalCertificateNameInputOptional
public readonly regionalCertificateNameInput: string;
  • Type: string

securityPolicyInputOptional
public readonly securityPolicyInput: 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}

certificateArnRequired
public readonly certificateArn: string;
  • Type: string

certificateBodyRequired
public readonly certificateBody: string;
  • Type: string

certificateChainRequired
public readonly certificateChain: string;
  • Type: string

certificateNameRequired
public readonly certificateName: string;
  • Type: string

certificatePrivateKeyRequired
public readonly certificatePrivateKey: string;
  • Type: string

domainNameRequired
public readonly domainName: string;
  • Type: string

idRequired
public readonly id: string;
  • Type: string

regionalCertificateArnRequired
public readonly regionalCertificateArn: string;
  • Type: string

regionalCertificateNameRequired
public readonly regionalCertificateName: string;
  • Type: string

securityPolicyRequired
public readonly securityPolicy: 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}

Constants

Name Type Description
tfResourceType string No description.

tfResourceTypeRequired
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}.

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[]

domainNameRequired
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}.


certificateArnOptional
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}.


certificateBodyOptional
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}.


certificateChainOptional
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}.


certificateNameOptional
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}.


certificatePrivateKeyOptional
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}.


endpointConfigurationOptional
public readonly endpointConfiguration: 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}


idOptional
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.


mutualTlsAuthenticationOptional
public readonly mutualTlsAuthentication: 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}


regionalCertificateArnOptional
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}.


regionalCertificateNameOptional
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}.


securityPolicyOptional
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}.


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

typesRequired
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}.

truststoreUriRequired
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}.


truststoreVersionOptional
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.

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

typesInputOptional
public readonly typesInput: string[];
  • Type: string[]

typesRequired
public readonly types: string[];
  • Type: string[]

internalValueOptional
public readonly internalValue: 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.

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.
resetTruststoreVersion 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.

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.

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

truststoreUriInputOptional
public readonly truststoreUriInput: string;
  • Type: string

truststoreVersionInputOptional
public readonly truststoreVersionInput: string;
  • Type: string

truststoreUriRequired
public readonly truststoreUri: string;
  • Type: string

truststoreVersionRequired
public readonly truststoreVersion: string;
  • Type: string

internalValueOptional
public readonly internalValue: ApiGatewayDomainNameMutualTlsAuthentication;