CfnDomainName

class aws_cdk.aws_apigateway.CfnDomainName(scope, id, *, certificate_arn=None, domain_name=None, endpoint_configuration=None, mutual_tls_authentication=None, ownership_verification_certificate_arn=None, regional_certificate_arn=None, security_policy=None, tags=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::ApiGateway::DomainName.

The AWS::ApiGateway::DomainName resource specifies a custom domain name for your API in API Gateway.

You can use a custom domain name to provide a URL that’s more intuitive and easier to recall. For more information about using custom domain names, see Set up Custom Domain Name for an API in API Gateway in the API Gateway Developer Guide .

CloudformationResource

AWS::ApiGateway::DomainName

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_apigateway as apigateway

cfn_domain_name = apigateway.CfnDomainName(self, "MyCfnDomainName",
    certificate_arn="certificateArn",
    domain_name="domainName",
    endpoint_configuration=apigateway.CfnDomainName.EndpointConfigurationProperty(
        types=["types"]
    ),
    mutual_tls_authentication=apigateway.CfnDomainName.MutualTlsAuthenticationProperty(
        truststore_uri="truststoreUri",
        truststore_version="truststoreVersion"
    ),
    ownership_verification_certificate_arn="ownershipVerificationCertificateArn",
    regional_certificate_arn="regionalCertificateArn",
    security_policy="securityPolicy",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Create a new AWS::ApiGateway::DomainName.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • certificate_arn (Optional[str]) – The reference to an AWS -managed certificate for use by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source. For requirements and additional information about setting up certificates, see Get Certificates Ready in AWS Certificate Manager in the API Gateway Developer Guide .

  • domain_name (Optional[str]) – The custom domain name for your API. Uppercase letters are not supported.

  • endpoint_configuration (Union[IResolvable, EndpointConfigurationProperty, None]) – A list of the endpoint types of the domain name.

  • mutual_tls_authentication (Union[IResolvable, MutualTlsAuthenticationProperty, None]) – The mutual TLS authentication configuration for a custom domain name.

  • ownership_verification_certificate_arn (Optional[str]) – The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn.

  • regional_certificate_arn (Optional[str]) – The reference to an AWS -managed certificate for use by the regional endpoint for the domain name. AWS Certificate Manager is the only supported source.

  • security_policy (Optional[str]) – The Transport Layer Security (TLS) version + cipher suite for this domain name. Valid values include TLS_1_0 and TLS_1_2 .

  • tags (Optional[Sequence[CfnTag]]) – An array of arbitrary tags (key-value pairs) to associate with the domain name.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

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

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::ApiGateway::DomainName'
attr_distribution_domain_name

The Amazon CloudFront distribution domain name that’s mapped to the custom domain name.

This is only applicable for endpoints whose type is EDGE .

Example: d111111abcdef8.cloudfront.net

CloudformationAttribute

DistributionDomainName

Return type

str

attr_distribution_hosted_zone_id

The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint.

The only valid value is Z2FDTNDATAQYW2 for all regions.

CloudformationAttribute

DistributionHostedZoneId

Return type

str

attr_regional_domain_name

The domain name associated with the regional endpoint for this custom domain name.

You set up this association by adding a DNS record that points the custom domain name to this regional domain name.

CloudformationAttribute

RegionalDomainName

Return type

str

attr_regional_hosted_zone_id

The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.

CloudformationAttribute

RegionalHostedZoneId

Return type

str

certificate_arn

The reference to an AWS -managed certificate for use by the edge-optimized endpoint for this domain name.

AWS Certificate Manager is the only supported source. For requirements and additional information about setting up certificates, see Get Certificates Ready in AWS Certificate Manager in the API Gateway Developer Guide .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-certificatearn

Return type

Optional[str]

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

domain_name

The custom domain name for your API.

Uppercase letters are not supported.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-domainname

Return type

Optional[str]

endpoint_configuration

A list of the endpoint types of the domain name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-endpointconfiguration

Return type

Union[IResolvable, EndpointConfigurationProperty, None]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

mutual_tls_authentication

The mutual TLS authentication configuration for a custom domain name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-mutualtlsauthentication

Return type

Union[IResolvable, MutualTlsAuthenticationProperty, None]

node

The construct tree node associated with this construct.

Return type

ConstructNode

ownership_verification_certificate_arn

The ARN of the public certificate issued by ACM to validate ownership of your custom domain.

Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-ownershipverificationcertificatearn

Return type

Optional[str]

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

regional_certificate_arn

The reference to an AWS -managed certificate for use by the regional endpoint for the domain name.

AWS Certificate Manager is the only supported source.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-regionalcertificatearn

Return type

Optional[str]

security_policy

The Transport Layer Security (TLS) version + cipher suite for this domain name.

Valid values include TLS_1_0 and TLS_1_2 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-securitypolicy

Return type

Optional[str]

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

tags

An array of arbitrary tags (key-value pairs) to associate with the domain name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-tags

Return type

TagManager

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

EndpointConfigurationProperty

class CfnDomainName.EndpointConfigurationProperty(*, types=None)

Bases: object

The EndpointConfiguration property type specifies the endpoint types of an Amazon API Gateway domain name.

EndpointConfiguration is a property of the AWS::ApiGateway::DomainName resource.

Parameters

types (Optional[Sequence[str]]) – A list of endpoint types of an API or its custom domain name. For an edge-optimized API and its custom domain name, the endpoint type is EDGE . For a regional API and its custom domain name, the endpoint type is REGIONAL .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-endpointconfiguration.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_apigateway as apigateway

endpoint_configuration_property = apigateway.CfnDomainName.EndpointConfigurationProperty(
    types=["types"]
)

Attributes

types

A list of endpoint types of an API or its custom domain name.

For an edge-optimized API and its custom domain name, the endpoint type is EDGE . For a regional API and its custom domain name, the endpoint type is REGIONAL .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-endpointconfiguration.html#cfn-apigateway-domainname-endpointconfiguration-types

Return type

Optional[List[str]]

MutualTlsAuthenticationProperty

class CfnDomainName.MutualTlsAuthenticationProperty(*, truststore_uri=None, truststore_version=None)

Bases: object

If specified, API Gateway performs two-way authentication between the client and the server.

Clients must present a trusted certificate to access your API.

Parameters
  • truststore_uri (Optional[str]) – An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3:// bucket-name / key-name . The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.

  • truststore_version (Optional[str]) – The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-mutualtlsauthentication.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_apigateway as apigateway

mutual_tls_authentication_property = apigateway.CfnDomainName.MutualTlsAuthenticationProperty(
    truststore_uri="truststoreUri",
    truststore_version="truststoreVersion"
)

Attributes

truststore_uri

An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3:// bucket-name / key-name .

The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-mutualtlsauthentication.html#cfn-apigateway-domainname-mutualtlsauthentication-truststoreuri

Return type

Optional[str]

truststore_version

The version of the S3 object that contains your truststore.

To specify a version, you must have versioning enabled for the S3 bucket.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-mutualtlsauthentication.html#cfn-apigateway-domainname-mutualtlsauthentication-truststoreversion

Return type

Optional[str]