CfnDomainNameMixinProps

class aws_cdk.mixins_preview.aws_apigateway.mixins.CfnDomainNameMixinProps(*, certificate_arn=None, domain_name=None, endpoint_access_mode=None, endpoint_configuration=None, mutual_tls_authentication=None, ownership_verification_certificate_arn=None, regional_certificate_arn=None, routing_mode=None, security_policy=None, tags=None)

Bases: object

Properties for CfnDomainNamePropsMixin.

Parameters:

certificate_arn (Optional[str]) – The reference to an AWS -managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. 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_access_mode (Optional[str]) – The endpoint access mode for your DomainName.
endpoint_configuration (Union[IResolvable, EndpointConfigurationProperty, Dict[str, Any], None]) – The endpoint configuration of this DomainName showing the endpoint types and IP address 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. Certificate Manager is the only supported source.
routing_mode (Optional[str]) – The routing mode for this domain name. The routing mode determines how API Gateway sends traffic from your custom domain name to your public APIs. Default: - “BASE_PATH_MAPPING_ONLY”
security_policy (Optional[str]) – The Transport Layer Security (TLS) version + cipher suite for this DomainName.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The collection of tags. Each tag element is associated with a given resource.

See:

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.
from aws_cdk.mixins_preview.aws_apigateway import mixins as apigateway_mixins

cfn_domain_name_mixin_props = apigateway_mixins.CfnDomainNameMixinProps(
    certificate_arn="certificateArn",
    domain_name="domainName",
    endpoint_access_mode="endpointAccessMode",
    endpoint_configuration=apigateway_mixins.CfnDomainNamePropsMixin.EndpointConfigurationProperty(
        ip_address_type="ipAddressType",
        types=["types"]
    ),
    mutual_tls_authentication=apigateway_mixins.CfnDomainNamePropsMixin.MutualTlsAuthenticationProperty(
        truststore_uri="truststoreUri",
        truststore_version="truststoreVersion"
    ),
    ownership_verification_certificate_arn="ownershipVerificationCertificateArn",
    regional_certificate_arn="regionalCertificateArn",
    routing_mode="routingMode",
    security_policy="securityPolicy",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

certificate_arn

The reference to an AWS -managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.

Certificate Manager is the only supported source.

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

domain_name

The custom domain name as an API host name, for example, my-api.example.com .

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

endpoint_access_mode

The endpoint access mode for your DomainName.

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

endpoint_configuration

The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name.

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

mutual_tls_authentication

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.