create_domain_name¶
Operation¶
async
¶
create_domain_name(input: CreateDomainNameInput, plugins: list[Plugin] | None = None) -> CreateDomainNameOutput
Creates a new domain name.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
CreateDomainNameInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
CreateDomainNameOutput
|
An instance of |
Input¶
dataclass
¶
A request to create a new domain name.
Attributes¶
class-attribute
instance-attribute
¶
certificate_arn: str | None = None
The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. Certificate Manager is the only supported source.
class-attribute
instance-attribute
¶
certificate_body: str | None = None
[Deprecated] The body of the server certificate that will be used by edge-optimized endpoint or private endpoint for this domain name provided by your certificate authority.
class-attribute
instance-attribute
¶
certificate_chain: str | None = None
[Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.
class-attribute
instance-attribute
¶
certificate_name: str | None = None
The user-friendly name of the certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.
class-attribute
instance-attribute
¶
certificate_private_key: str | None = None
[Deprecated] Your edge-optimized endpoint's domain name certificate's private key.
class-attribute
instance-attribute
¶
domain_name: str | None = None
The name of the DomainName resource.
class-attribute
instance-attribute
¶
endpoint_access_mode: EndpointAccessMode | None = None
The endpoint access mode of the DomainName. Only available for
DomainNames that use security policies that start with
SecurityPolicy_.
class-attribute
instance-attribute
¶
endpoint_configuration: EndpointConfiguration | None = None
The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name.
class-attribute
instance-attribute
¶
mutual_tls_authentication: MutualTlsAuthenticationInput | None = 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.
class-attribute
instance-attribute
¶
ownership_verification_certificate_arn: str | None = None
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.
class-attribute
instance-attribute
¶
policy: str | None = None
A stringified JSON policy document that applies to the execute-api
service for this DomainName regardless of the caller and Method
configuration. Supported only for private custom domain names.
class-attribute
instance-attribute
¶
regional_certificate_arn: str | None = None
The reference to an Amazon Web Services-managed certificate that will be used by regional endpoint for this domain name. Certificate Manager is the only supported source.
class-attribute
instance-attribute
¶
regional_certificate_name: str | None = None
The user-friendly name of the certificate that will be used by regional endpoint for this domain name.
class-attribute
instance-attribute
¶
routing_mode: RoutingMode | None = None
The routing mode for this domain name. The routing mode determines how API Gateway sends traffic from your custom domain name to your private APIs.
class-attribute
instance-attribute
¶
security_policy: SecurityPolicy | None = None
The Transport Layer Security (TLS) version + cipher suite for this DomainName.
class-attribute
instance-attribute
¶
tags: dict[str, str] | None = None
The key-value map of strings. The valid character set is
[a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not
start with aws:. The tag value can be up to 256 characters.
Output¶
dataclass
¶
Represents a custom domain name as a user-friendly host name of an API (RestApi).
Attributes¶
class-attribute
instance-attribute
¶
certificate_arn: str | None = None
The reference to an Amazon Web Services-managed certificate that will be used by edge-optimized endpoint or private endpoint for this domain name. Certificate Manager is the only supported source.
class-attribute
instance-attribute
¶
certificate_name: str | None = None
The name of the certificate that will be used by edge-optimized endpoint or private endpoint for this domain name.
class-attribute
instance-attribute
¶
certificate_upload_date: datetime | None = None
The timestamp when the certificate that was used by edge-optimized endpoint or private endpoint for this domain name was uploaded.
class-attribute
instance-attribute
¶
distribution_domain_name: str | None = None
The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.
class-attribute
instance-attribute
¶
distribution_hosted_zone_id: str | None = None
The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized
endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For
more information, see Set up a Regional Custom Domain Name and AWS
Regions and Endpoints for API Gateway.
class-attribute
instance-attribute
¶
domain_name: str | None = None
The custom domain name as an API host name, for example,
my-api.example.com.
class-attribute
instance-attribute
¶
domain_name_arn: str | None = None
The ARN of the domain name.
class-attribute
instance-attribute
¶
domain_name_id: str | None = None
The identifier for the domain name resource. Supported only for private custom domain names.
class-attribute
instance-attribute
¶
domain_name_status: DomainNameStatus | None = None
The status of the DomainName migration. The valid values are AVAILABLE
and UPDATING. If the status is UPDATING, the domain cannot be
modified further until the existing operation is complete. If it is
AVAILABLE, the domain can be updated.
class-attribute
instance-attribute
¶
domain_name_status_message: str | None = None
An optional text message containing detailed information about status of the DomainName migration.
class-attribute
instance-attribute
¶
endpoint_access_mode: EndpointAccessMode | None = None
The endpoint access mode of the DomainName.
class-attribute
instance-attribute
¶
endpoint_configuration: EndpointConfiguration | None = None
The endpoint configuration of this DomainName showing the endpoint types and IP address types of the domain name.
class-attribute
instance-attribute
¶
management_policy: str | None = None
A stringified JSON policy document that applies to the API Gateway Management service for this DomainName. This policy document controls access for access association sources to create domain name access associations with this DomainName. Supported only for private custom domain names.
class-attribute
instance-attribute
¶
mutual_tls_authentication: MutualTlsAuthentication | None = 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.
class-attribute
instance-attribute
¶
ownership_verification_certificate_arn: str | None = None
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.
class-attribute
instance-attribute
¶
policy: str | None = None
A stringified JSON policy document that applies to the execute-api
service for this DomainName regardless of the caller and Method
configuration. Supported only for private custom domain names.
class-attribute
instance-attribute
¶
regional_certificate_arn: str | None = None
The reference to an Amazon Web Services-managed certificate that will be used for validating the regional domain name. Certificate Manager is the only supported source.
class-attribute
instance-attribute
¶
regional_certificate_name: str | None = None
The name of the certificate that will be used for validating the regional domain name.
class-attribute
instance-attribute
¶
regional_domain_name: str | None = None
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. The regional domain name is returned by API Gateway when you create a regional endpoint.
class-attribute
instance-attribute
¶
regional_hosted_zone_id: str | None = None
The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.
class-attribute
instance-attribute
¶
routing_mode: RoutingMode | None = None
The routing mode for this domain name. The routing mode determines how API Gateway sends traffic from your custom domain name to your private APIs.
class-attribute
instance-attribute
¶
security_policy: SecurityPolicy | None = None
The Transport Layer Security (TLS) version + cipher suite for this DomainName.
class-attribute
instance-attribute
¶
tags: dict[str, str] | None = None
The collection of tags. Each tag element is associated with a given resource.