Refer to the Terraform Registory for docs: aws_api_gateway_domain_name
.
Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/3.76.1/docs/resources/api_gateway_domain_name aws_api_gateway_domain_name}.
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. |
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The scoped construct ID.
Must be unique amongst siblings in the same scope
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. |
public toString(): string
Returns a string representation of this construct.
public addOverride(path: string, value: any): void
- Type: string
- Type: any
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
public toMetadata(): any
public toTerraform(): any
Adds this resource to the terraform JSON output.
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable
- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
- Type: string
public getListAttribute(terraformAttribute: string): string[]
- Type: string
public getNumberAttribute(terraformAttribute: string): number
- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]
- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
- Type: string
public getStringAttribute(terraformAttribute: string): string
- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
- Type: string
public interpolationForAttribute(terraformAttribute: string): IResolvable
- Type: string
public putEndpointConfiguration(value: ApiGatewayDomainNameEndpointConfiguration): void
public putMutualTlsAuthentication(value: ApiGatewayDomainNameMutualTlsAuthentication): void
public resetCertificateArn(): void
public resetCertificateBody(): void
public resetCertificateChain(): void
public resetCertificateName(): void
public resetCertificatePrivateKey(): void
public resetEndpointConfiguration(): void
public resetId(): void
public resetMutualTlsAuthentication(): void
public resetRegionalCertificateArn(): void
public resetRegionalCertificateName(): void
public resetSecurityPolicy(): void
public resetTags(): void
public resetTagsAll(): void
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
isTerraformElement |
No description. |
isTerraformResource |
No description. |
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.
- Type: any
Any object.
import { apiGatewayDomainName } from '@cdktf/aws-cdk'
apiGatewayDomainName.ApiGatewayDomainName.isTerraformElement(x: any)
- Type: any
import { apiGatewayDomainName } from '@cdktf/aws-cdk'
apiGatewayDomainName.ApiGatewayDomainName.isTerraformResource(x: any)
- Type: any
Name | Type | Description |
---|---|---|
node |
constructs.Node |
The tree node. |
cdktfStack |
cdktf.TerraformStack |
No description. |
fqn |
string |
No description. |
friendlyUniqueId |
string |
No description. |
terraformMetaArguments |
{[ key: string ]: any} |
No description. |
terraformResourceType |
string |
No description. |
terraformGeneratorMetadata |
cdktf.TerraformProviderGeneratorMetadata |
No description. |
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. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
public readonly cdktfStack: TerraformStack;
- Type: cdktf.TerraformStack
public readonly fqn: string;
- Type: string
public readonly friendlyUniqueId: string;
- Type: string
public readonly terraformMetaArguments: {[ key: string ]: any};
- Type: {[ key: string ]: any}
public readonly terraformResourceType: string;
- Type: string
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
- Type: cdktf.TerraformProviderGeneratorMetadata
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: string[];
- Type: string[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly arn: string;
- Type: string
public readonly certificateUploadDate: string;
- Type: string
public readonly cloudfrontDomainName: string;
- Type: string
public readonly cloudfrontZoneId: string;
- Type: string
public readonly endpointConfiguration: ApiGatewayDomainNameEndpointConfigurationOutputReference;
public readonly mutualTlsAuthentication: ApiGatewayDomainNameMutualTlsAuthenticationOutputReference;
public readonly regionalDomainName: string;
- Type: string
public readonly regionalZoneId: string;
- Type: string
public readonly certificateArnInput: string;
- Type: string
public readonly certificateBodyInput: string;
- Type: string
public readonly certificateChainInput: string;
- Type: string
public readonly certificateNameInput: string;
- Type: string
public readonly certificatePrivateKeyInput: string;
- Type: string
public readonly domainNameInput: string;
- Type: string
public readonly endpointConfigurationInput: ApiGatewayDomainNameEndpointConfiguration;
public readonly idInput: string;
- Type: string
public readonly mutualTlsAuthenticationInput: ApiGatewayDomainNameMutualTlsAuthentication;
public readonly regionalCertificateArnInput: string;
- Type: string
public readonly regionalCertificateNameInput: string;
- Type: string
public readonly securityPolicyInput: string;
- Type: string
public readonly tagsAllInput: {[ key: string ]: string};
- Type: {[ key: string ]: string}
public readonly tagsInput: {[ key: string ]: string};
- Type: {[ key: string ]: string}
public readonly certificateArn: string;
- Type: string
public readonly certificateBody: string;
- Type: string
public readonly certificateChain: string;
- Type: string
public readonly certificateName: string;
- Type: string
public readonly certificatePrivateKey: string;
- Type: string
public readonly domainName: string;
- Type: string
public readonly id: string;
- Type: string
public readonly regionalCertificateArn: string;
- Type: string
public readonly regionalCertificateName: string;
- Type: string
public readonly securityPolicy: string;
- Type: string
public readonly tags: {[ key: string ]: string};
- Type: {[ key: string ]: string}
public readonly tagsAll: {[ key: string ]: string};
- Type: {[ key: string ]: string}
Name | Type | Description |
---|---|---|
tfResourceType |
string |
No description. |
public readonly tfResourceType: string;
- Type: string
import { apiGatewayDomainName } from '@cdktf/aws-cdk'
const apiGatewayDomainNameConfig: apiGatewayDomainName.ApiGatewayDomainNameConfig = { ... }
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: ITerraformDependable[];
- Type: cdktf.ITerraformDependable[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly 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}.
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}.
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}.
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}.
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}.
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}.
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}
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.
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}
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}.
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}.
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}.
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}.
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}.
import { apiGatewayDomainName } from '@cdktf/aws-cdk'
const apiGatewayDomainNameEndpointConfiguration: apiGatewayDomainName.ApiGatewayDomainNameEndpointConfiguration = { ... }
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}. |
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}.
import { apiGatewayDomainName } from '@cdktf/aws-cdk'
const apiGatewayDomainNameMutualTlsAuthentication: apiGatewayDomainName.ApiGatewayDomainNameMutualTlsAuthentication = { ... }
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}. |
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}.
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}.
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. |
- Type: cdktf.IInterpolatingParent
The parent resource.
- Type: string
The attribute on the parent resource this class is referencing.
Name | Description |
---|---|
computeFqn |
No description. |
getAnyMapAttribute |
No description. |
getBooleanAttribute |
No description. |
getBooleanMapAttribute |
No description. |
getListAttribute |
No description. |
getNumberAttribute |
No description. |
getNumberListAttribute |
No description. |
getNumberMapAttribute |
No description. |
getStringAttribute |
No description. |
getStringMapAttribute |
No description. |
interpolationForAttribute |
No description. |
resolve |
Produce the Token's value at resolution time. |
toString |
Return a string representation of this resolvable object. |
public computeFqn(): string
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable
- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
- Type: string
public getListAttribute(terraformAttribute: string): string[]
- Type: string
public getNumberAttribute(terraformAttribute: string): number
- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]
- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
- Type: string
public getStringAttribute(terraformAttribute: string): string
- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
- Type: string
public interpolationForAttribute(property: string): IResolvable
- Type: string
public resolve(_context: IResolveContext): any
Produce the Token's value at resolution time.
- Type: cdktf.IResolveContext
public toString(): string
Return a string representation of this resolvable object.
Returns a reversible string representation.
Name | Type | Description |
---|---|---|
creationStack |
string[] |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
string |
No description. |
typesInput |
string[] |
No description. |
types |
string[] |
No description. |
internalValue |
ApiGatewayDomainNameEndpointConfiguration |
No description. |
public readonly creationStack: string[];
- Type: string[]
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
public readonly fqn: string;
- Type: string
public readonly typesInput: string[];
- Type: string[]
public readonly types: string[];
- Type: string[]
public readonly internalValue: ApiGatewayDomainNameEndpointConfiguration;
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. |
- Type: cdktf.IInterpolatingParent
The parent resource.
- Type: string
The attribute on the parent resource this class is referencing.
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. |
public computeFqn(): string
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable
- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
- Type: string
public getListAttribute(terraformAttribute: string): string[]
- Type: string
public getNumberAttribute(terraformAttribute: string): number
- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]
- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
- Type: string
public getStringAttribute(terraformAttribute: string): string
- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
- Type: string
public interpolationForAttribute(property: string): IResolvable
- Type: string
public resolve(_context: IResolveContext): any
Produce the Token's value at resolution time.
- Type: cdktf.IResolveContext
public toString(): string
Return a string representation of this resolvable object.
Returns a reversible string representation.
public resetTruststoreVersion(): void
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. |
public readonly creationStack: string[];
- Type: string[]
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
public readonly fqn: string;
- Type: string
public readonly truststoreUriInput: string;
- Type: string
public readonly truststoreVersionInput: string;
- Type: string
public readonly truststoreUri: string;
- Type: string
public readonly truststoreVersion: string;
- Type: string
public readonly internalValue: ApiGatewayDomainNameMutualTlsAuthentication;