DomainConfiguration

A configuração necessária para gerar recursos AWS::ApiGateway::DomainNameAccessAssociation.

AWS SAM gera um recurso AWS::ApiGateway::DomainNameAccessAssociation quando essa propriedade é definida. Para obter informações sobre recursos gerados do CloudFormation, consulte Recursos gerados do CloudFormation para o AWS SAM.

Tipo: DomainAccessAssociation

Obrigatório: não

Compatibilidade CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem CloudFormation equivalente.

Uma lista dos caminhos básicos a serem configurados com o nome de domínio do Amazon API Gateway.

Tipo: lista

Obrigatório: não

Padrão: /

Compatibilidade CloudFormation: essa propriedade é semelhante à propriedade BasePathde um recurso AWS::ApiGateway::BasePathMapping. AWS SAM cria vários recursos AWS::ApiGateway::BasePathMapping, um por BasePath especificado nessa propriedade.

O nome de recurso da Amazon (ARN) de um certificado gerenciado do AWS endpoint deste nome de domínio. AWS Certificate Manager é a única origem compatível.

Tipo: string

Obrigatório: Sim

Compatibilidade CloudFormation: essa propriedade é semelhante à propriedade CertificateArn de um recurso AWS::ApiGateway::DomainName. Se EndpointConfiguration estiver definido como REGIONAL (o valor padrão), CertificateArn mapeia para RegionalCertificateARN em AWS::ApiGateway::DomainName. Se EndpointConfiguration estiver definido como EDGE, CertificateArn mapeia para CertificateArn in em AWS::ApiGateway::DomainName. Se EndpointConfiguration estiver definida como PRIVATE, essa propriedade será passada ao recurso AWS::ApiGateway::DomainNameV2.

Observações adicionais: Para um EDGE endpoint, você deve criar o certificado na região us-east-1 AWS.

O nome de domínio personalizado para a sua API Gateway API. Letras maiúsculas não são compatíveis.

AWS SAM gera um recurso AWS::ApiGateway::DomainName quando essa propriedade é definida. Para obter informações sobre esse cenário, consulte A propriedade domainName é especificada. Para obter informações sobre recursos gerados do CloudFormation, consulte Recursos gerados do CloudFormation para o AWS SAM.

Tipo: string

Obrigatório: Sim

Compatibilidade do CloudFormation: essa propriedade é passada diretamente para a propriedade DomainName de um recurso AWS::ApiGateway::DomainName ou para AWS::ApiGateway::DomainNameV2 quando EndpointConfiguration é definida como PRIVATE.

Define o tipo de endpoint do API Gateway a ser mapeado para o domínio personalizado. O valor dessa propriedade determina como a propriedade CertificateArn é mapeada CloudFormation.

Valores válidos: EDGE, REGIONAL ou PRIVATE

Tipo: string

Obrigatório: não

Padrão: REGIONAL

Compatibilidade CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem CloudFormation equivalente.

A Transport Layer Security (TLS) mútua para um nome de domínio personalizado.

Type: MutualTlsAuthentication

Obrigatório: não

Compatibilidade CloudFormation: essa propriedade é passada diretamente para a propriedade MutualTlsAuthentication de um recurso AWS::ApiGateway::DomainName.

Indica se caracteres não alfanuméricos são permitidos nos caminhos base definidos pela propriedade BasePath. Quando definido como True, caracteres não alfanuméricos são removidos dos caminhos base.

Use a propriedade NormalizeBasePath para BasePath.

Tipo: booliano

Obrigatório: não

Padrão: verdadeiro

Compatibilidade CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem CloudFormation equivalente.

O ARN do certificado público emitido pelo ACM para validar a propriedade do domínio personalizado. Necessário somente para configurar o TLS mútuo e para especificar um ARN de CA privado ou importado do ACM para o CertificateArn.

Tipo: string

Obrigatório: não

Compatibilidade CloudFormation: essa propriedade é passada diretamente para a propriedade OwnershipVerificationCertificateArn de um recurso AWS::ApiGateway::DomainName.

A política do IAM para anexar ao nome de domínio do API Gateway. Aplicável somente quando EndpointConfiguration for definida como PRIVATE.

Tipo: Json

Obrigatório: não

Compatibilidade do CloudFormation: essa propriedade é passada diretamente para a propriedade Policy de um recurso AWS::ApiGateway::DomainNameV2, quando EndpointConfiguration for definida como PRIVATE. Para ver exemplos de documentos de política válidos, consulte AWS::ApiGateway::DomainNameV2.

Define uma configuração do Amazon Route 53.

Tipo:: Route53Configuration

Obrigatório: não

Compatibilidade CloudFormation: Essa propriedade é exclusiva do AWS SAM e não tem CloudFormation equivalente.

O pacote de criptografia TLS mais o pacote de criptografia para este nome de domínio.

Tipo: string

Obrigatório: não

Compatibilidade do CloudFormation: essa propriedade é passada diretamente para a propriedade SecurityPolicy de um recurso AWS::ApiGateway::DomainName, ou para AWS::ApiGateway::DomainNameV2 quando EndpointConfiguration for definida como PRIVATE. Para endpoints PRIVATE, somente TLS_1_2 é compatível.