Bases: 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 .
AWS::ApiGateway::DomainName
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.
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 that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
domain_name (Optional[str]) â The custom domain name as an API host name, for example, my-api.example.com .
endpoint_configuration (Union[IResolvable, EndpointConfigurationProperty, Dict[str, Any], None]) â The endpoint configuration of this DomainName showing the endpoint types of the domain name.
mutual_tls_authentication (Union[IResolvable, MutualTlsAuthenticationProperty, Dict[str, Any], None]) â The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
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 that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.
security_policy (Optional[str]) â The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2 .
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) â The collection of tags. Each tag element is associated with a given resource.
Methods
Syntactic sugar for addOverride(path, undefined).
path (str) â The path of the value to delete.
None
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.
target (CfnResource)
None
Add a value to the CloudFormation Resource Metadata.
key (str)
value (Any)
None
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.
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.
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.
None
Adds an override that deletes the value of a property from the resource definition.
property_path (str) â The path to the property.
None
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value).
property_path (str) â The path of the property.
value (Any) â The value.
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).
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.
None
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.
attribute_name (str) â The name of the attribute.
Retrieve a value value from the CloudFormation Resource Metadata.
key (str)
Any
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.
Examines the CloudFormation resource and discloses attributes.
inspector (TreeInspector) â
tree inspector to collect and process attributes.
None
Overrides the auto-generated logical ID with a specific ID.
new_logical_id (str) â The new logical ID to use for this stack element.
None
Returns a string representation of this construct.
str
a string representation of this resource
Attributes
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
DistributionDomainName
The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint.
The only valid value is Z2FDTNDATAQYW2 for all regions.
DistributionHostedZoneId
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.
RegionalDomainName
The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint.
RegionalHostedZoneId
The reference to an AWS -managed certificate that will be used by edge-optimized endpoint for this domain name.
AWS Certificate Manager is the only supported source.
Options for this resource, such as condition, update policy etc.
AWS resource type.
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.
The custom domain name as an API host name, for example, my-api.example.com .
The endpoint configuration of this DomainName showing the endpoint types of the domain name.
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).
the logical ID as a stringified token. This value will only get resolved during synthesis.
The mutual TLS authentication configuration for a custom domain name.
If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
The construct tree node associated with this construct.
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.
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 }).
The reference to an AWS -managed certificate that will be used for validating the regional domain name.
AWS Certificate Manager is the only supported source.
The Transport Layer Security (TLS) version + cipher suite for this DomainName.
The valid values are TLS_1_0 and TLS_1_2 .
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
The collection of tags.
Each tag element is associated with a given resource.
Static Methods
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.
x (Any)
bool
The construct as a stack element or undefined if it is not a stack element.
Check whether the given construct is a CfnResource.
construct (IConstruct)
bool
Return whether the given object is a Construct.
x (Any)
bool
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.
types (Optional[Sequence[str]]) â A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). 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 . For a private API, the endpoint type is PRIVATE .
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
A list of endpoint types of an API (RestApi) or its custom domain name (DomainName).
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 . For a private API, the endpoint type is PRIVATE .
Bases: object
The mutual TLS authentication configuration for a custom domain name.
If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
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.
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
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.
The version of the S3 object that contains your truststore.
To specify a version, you must have versioning enabled for the S3 bucket.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4