DomainName

public struct DomainName : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

    Declaration

    Swift

    public let certificateArn: String?

  • The name of the certificate that will be used by edge-optimized endpoint for this domain name.

    Declaration

    Swift

    public let certificateName: String?

  • The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

    Declaration

    Swift

    public let certificateUploadDate: TimeStamp?

  • 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.

    Declaration

    Swift

    public let distributionDomainName: String?

  • 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.

    Declaration

    Swift

    public let distributionHostedZoneId: String?

  • The custom domain name as an API host name, for example, my-api.example.com.

    Declaration

    Swift

    public let domainName: String?

  • 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.

    Declaration

    Swift

    public let domainNameStatus: DomainNameStatus?

  • An optional text message containing detailed information about status of the DomainName migration.

    Declaration

    Swift

    public let domainNameStatusMessage: String?

  • The endpoint configuration of this DomainName showing the endpoint types of the domain name.

    Declaration

    Swift

    public let endpointConfiguration: EndpointConfiguration?

  • The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

    Declaration

    Swift

    public let regionalCertificateArn: String?

  • The name of the certificate that will be used for validating the regional domain name.

    Declaration

    Swift

    public let regionalCertificateName: String?

  • 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.

    Declaration

    Swift

    public let regionalDomainName: String?

  • 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.

    Declaration

    Swift

    public let regionalHostedZoneId: String?

  • The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

    Declaration

    Swift

    public let securityPolicy: SecurityPolicy?

  • The collection of tags. Each tag element is associated with a given resource.

    Declaration

    Swift

    public let tags: [String : String]?

  • Undocumented

    Declaration

    Swift

    public init(certificateArn: String? = nil, certificateName: String? = nil, certificateUploadDate: TimeStamp? = nil, distributionDomainName: String? = nil, distributionHostedZoneId: String? = nil, domainName: String? = nil, domainNameStatus: DomainNameStatus? = nil, domainNameStatusMessage: String? = nil, endpointConfiguration: EndpointConfiguration? = nil, regionalCertificateArn: String? = nil, regionalCertificateName: String? = nil, regionalDomainName: String? = nil, regionalHostedZoneId: String? = nil, securityPolicy: SecurityPolicy? = nil, tags: [String : String]? = nil)