DomainConfiguration

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

AWS SAM gera um AWS::ApiGateway::DomainNameAccessAssociationrecurso quando essa propriedade é definida. Para obter informações sobre AWS CloudFormation os recursos gerados, consulteAWS CloudFormation Recursos gerados para AWS SAM.

Digite: DomainAccessAssociation

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é exclusiva AWS SAM e não tem AWS 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: /

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

O Amazon Resource Name (ARN) de um certificado AWS gerenciado é o endpoint desse nome de domínio. AWS Certificate Manager é a única fonte compatível.

Tipo: string

Obrigatório: Sim

AWS CloudFormation compatibilidade: essa propriedade é semelhante à CertificateArn propriedade de um AWS::ApiGateway::DomainName recurso. Se EndpointConfiguration estiver definido como REGIONAL (o valor padrão), CertificateArn mapeia para RegionalCertificateArninAWS::ApiGateway::DomainName. Se EndpointConfiguration estiver definido comoEDGE, CertificateArn mapeia para CertificateArninAWS::ApiGateway::DomainName. Se EndpointConfiguration estiver definido comoPRIVATE, essa propriedade será passada para o recurso AWS::ApiGateway::DomainNameV2.

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

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 AWS::ApiGateway::DomainNamerecurso quando essa propriedade é definida. Para obter informações sobre esse cenário, consulte DomainNamepropriedade é especificada. Para obter informações sobre AWS CloudFormation os recursos gerados, consulteAWS CloudFormation Recursos gerados para AWS SAM.

Tipo: string

Obrigatório: Sim

AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a DomainName propriedade de um AWS::ApiGateway::DomainName recurso ou para AWS::ApiGateway::DomainNameV2quando EndpointConfiguration está definida comoPRIVATE.

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

Valores válidos: EDGE, REGIONAL ou PRIVATE

Tipo: string

Obrigatório: não

Padrão: REGIONAL

AWS CloudFormation compatibilidade: essa propriedade é exclusiva AWS SAM e não tem AWS CloudFormation equivalente.

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

Digite: MutualTlsAuthentication

Obrigatório: não

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

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

AWS CloudFormation compatibilidade: essa propriedade é exclusiva AWS SAM e não tem AWS 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

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

A política do IAM a ser anexada ao nome de domínio do API Gateway. Aplicável somente quando EndpointConfiguration está definido comoPRIVATE.

Tipo: Json

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a Policy propriedade de um AWS::ApiGateway::DomainNameV2 recurso quando EndpointConfiguration está definida comoPRIVATE. Para 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

AWS CloudFormation compatibilidade: essa propriedade é exclusiva AWS SAM e não tem AWS CloudFormation equivalente.

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

Tipo: string

Obrigatório: não

AWS CloudFormation compatibilidade: essa propriedade é passada diretamente para a SecurityPolicy propriedade de um AWS::ApiGateway::DomainName recurso ou para AWS::ApiGateway::DomainNameV2quando EndpointConfiguration está definida comoPRIVATE. Para PRIVATE endpoints, somente TLS_1_2 é suportado.