CfnDomainNameMixinProps
- class aws_cdk.mixins_preview.aws_apigatewayv2.mixins.CfnDomainNameMixinProps(*, domain_name=None, domain_name_configurations=None, mutual_tls_authentication=None, routing_mode=None, tags=None)
Bases:
objectProperties for CfnDomainNamePropsMixin.
- Parameters:
domain_name (
Optional[str]) – The custom domain name for your API in Amazon API Gateway. Uppercase letters and the underscore (_) character are not supported.domain_name_configurations (
Union[IResolvable,Sequence[Union[IResolvable,DomainNameConfigurationProperty,Dict[str,Any]]],None]) – The domain name configurations.mutual_tls_authentication (
Union[IResolvable,MutualTlsAuthenticationProperty,Dict[str,Any],None]) – The mutual TLS authentication configuration for a custom domain name.routing_mode (
Optional[str]) – The routing mode API Gateway uses to route traffic to your APIs. Default: - “API_MAPPING_ONLY”tags (
Optional[Mapping[str,str]]) – The collection of tags associated with a domain name.
- See:
- 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_apigatewayv2 import mixins as apigatewayv2_mixins cfn_domain_name_mixin_props = apigatewayv2_mixins.CfnDomainNameMixinProps( domain_name="domainName", domain_name_configurations=[apigatewayv2_mixins.CfnDomainNamePropsMixin.DomainNameConfigurationProperty( certificate_arn="certificateArn", certificate_name="certificateName", endpoint_type="endpointType", ip_address_type="ipAddressType", ownership_verification_certificate_arn="ownershipVerificationCertificateArn", security_policy="securityPolicy" )], mutual_tls_authentication=apigatewayv2_mixins.CfnDomainNamePropsMixin.MutualTlsAuthenticationProperty( truststore_uri="truststoreUri", truststore_version="truststoreVersion" ), routing_mode="routingMode", tags={ "tags_key": "tags" } )
Attributes
- domain_name
The custom domain name for your API in Amazon API Gateway.
Uppercase letters and the underscore (
_) character are not supported.
- domain_name_configurations
The domain name configurations.
- mutual_tls_authentication
The mutual TLS authentication configuration for a custom domain name.
- routing_mode
The routing mode API Gateway uses to route traffic to your APIs.
- tags
The collection of tags associated with a domain name.