DomainNameOptions

class aws_cdk.aws_apigateway.DomainNameOptions(*, certificate, domain_name, endpoint_type=None, security_policy=None)

Bases: object

__init__(*, certificate, domain_name, endpoint_type=None, security_policy=None)
Parameters
  • certificate (ICertificate) – The reference to an AWS-managed certificate for use by the edge-optimized endpoint for the domain name. For “EDGE” domain names, the certificate needs to be in the US East (N. Virginia) region.

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

  • endpoint_type (Optional[EndpointType]) – The type of endpoint for this DomainName. Default: REGIONAL

  • security_policy (Optional[SecurityPolicy]) – The Transport Layer Security (TLS) version + cipher suite for this domain name. Default: SecurityPolicy.TLS_1_0

Return type

None

Attributes

certificate

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

For “EDGE” domain names, the certificate needs to be in the US East (N. Virginia) region.

Return type

ICertificate

domain_name

The custom domain name for your API.

Uppercase letters are not supported.

Return type

str

endpoint_type

The type of endpoint for this DomainName.

default :default: REGIONAL

Return type

Optional[EndpointType]

security_policy

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

default :default: SecurityPolicy.TLS_1_0

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

Return type

Optional[SecurityPolicy]