interface CfnDomainNameV2Props
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.APIGateway.CfnDomainNameV2Props |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#CfnDomainNameV2Props |
![]() | software.amazon.awscdk.services.apigateway.CfnDomainNameV2Props |
![]() | aws_cdk.aws_apigateway.CfnDomainNameV2Props |
![]() | aws-cdk-lib » aws_apigateway » CfnDomainNameV2Props |
Properties for defining a CfnDomainNameV2
.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apigateway as apigateway } from 'aws-cdk-lib';
declare const policy: any;
const cfnDomainNameV2Props: apigateway.CfnDomainNameV2Props = {
certificateArn: 'certificateArn',
domainName: 'domainName',
endpointConfiguration: {
types: ['types'],
},
policy: policy,
securityPolicy: 'securityPolicy',
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
Name | Type | Description |
---|---|---|
certificate | string | The reference to an AWS -managed certificate that will be used by the private endpoint for this domain name. |
domain | string | Represents a custom domain name as a user-friendly host name of an API (RestApi). |
endpoint | IResolvable | Endpoint | The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has. |
policy? | any | A stringified JSON policy document that applies to the execute-api service for this DomainName regardless of the caller and Method configuration. |
security | string | The Transport Layer Security (TLS) version + cipher suite for this DomainName. |
tags? | Cfn [] | The collection of tags. |
certificateArn?
Type:
string
(optional)
The reference to an AWS -managed certificate that will be used by the private endpoint for this domain name.
AWS Certificate Manager is the only supported source.
domainName?
Type:
string
(optional)
Represents a custom domain name as a user-friendly host name of an API (RestApi).
endpointConfiguration?
Type:
IResolvable
|
Endpoint
(optional)
The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.
policy?
Type:
any
(optional)
A stringified JSON policy document that applies to the execute-api
service for this DomainName regardless of the caller and Method configuration.
You can use Fn::ToJsonString
to enter your policy
. For more information, see Fn::ToJsonString .
securityPolicy?
Type:
string
(optional)
The Transport Layer Security (TLS) version + cipher suite for this DomainName.
Only TLS_1_2
is supported.
tags?
Type:
Cfn
[]
(optional)
The collection of tags.
Each tag element is associated with a given resource.