« blib/lib/Paws/ApiGateway/DocumentationVersions.pm
↑ Summary
blib/lib/Paws/ApiGateway/DomainNames.pm »
| 1 | |||
| 2 | package Paws::ApiGateway::DomainName; | ||
| 3 | use Moose; | ||
| 4 | has CertificateArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'certificateArn'); | ||
| 5 | has CertificateName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'certificateName'); | ||
| 6 | has CertificateUploadDate => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'certificateUploadDate'); | ||
| 7 | has DistributionDomainName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'distributionDomainName'); | ||
| 8 | has DistributionHostedZoneId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'distributionHostedZoneId'); | ||
| 9 | has DomainName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'domainName'); | ||
| 10 | has DomainNameStatus => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'domainNameStatus'); | ||
| 11 | has DomainNameStatusMessage => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'domainNameStatusMessage'); | ||
| 12 | has EndpointConfiguration => (is => 'ro', isa => 'Paws::ApiGateway::EndpointConfiguration', traits => ['NameInRequest'], request_name => 'endpointConfiguration'); | ||
| 13 | has MutualTlsAuthentication => (is => 'ro', isa => 'Paws::ApiGateway::MutualTlsAuthentication', traits => ['NameInRequest'], request_name => 'mutualTlsAuthentication'); | ||
| 14 | has RegionalCertificateArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'regionalCertificateArn'); | ||
| 15 | has RegionalCertificateName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'regionalCertificateName'); | ||
| 16 | has RegionalDomainName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'regionalDomainName'); | ||
| 17 | has RegionalHostedZoneId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'regionalHostedZoneId'); | ||
| 18 | has SecurityPolicy => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'securityPolicy'); | ||
| 19 | has Tags => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToString', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 20 | |||
| 21 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 22 | 1; | ||
| 23 | |||
| 24 | ### main pod documentation begin ### | ||
| 25 | |||
| 26 | =head1 NAME | ||
| 27 | |||
| 28 | Paws::ApiGateway::DomainName | ||
| 29 | |||
| 30 | =head1 ATTRIBUTES | ||
| 31 | |||
| 32 | |||
| 33 | =head2 CertificateArn => Str | ||
| 34 | |||
| 35 | The reference to an AWS-managed certificate that will be used by | ||
| 36 | edge-optimized endpoint for this domain name. AWS Certificate Manager | ||
| 37 | is the only supported source. | ||
| 38 | |||
| 39 | |||
| 40 | =head2 CertificateName => Str | ||
| 41 | |||
| 42 | The name of the certificate that will be used by edge-optimized | ||
| 43 | endpoint for this domain name. | ||
| 44 | |||
| 45 | |||
| 46 | =head2 CertificateUploadDate => Str | ||
| 47 | |||
| 48 | The timestamp when the certificate that was used by edge-optimized | ||
| 49 | endpoint for this domain name was uploaded. | ||
| 50 | |||
| 51 | |||
| 52 | =head2 DistributionDomainName => Str | ||
| 53 | |||
| 54 | The domain name of the Amazon CloudFront distribution associated with | ||
| 55 | this custom domain name for an edge-optimized endpoint. You set up this | ||
| 56 | association when adding a DNS record pointing the custom domain name to | ||
| 57 | this distribution name. For more information about CloudFront | ||
| 58 | distributions, see the Amazon CloudFront documentation | ||
| 59 | (https://aws.amazon.com/documentation/cloudfront/). | ||
| 60 | |||
| 61 | |||
| 62 | =head2 DistributionHostedZoneId => Str | ||
| 63 | |||
| 64 | The region-agnostic Amazon Route 53 Hosted Zone ID of the | ||
| 65 | edge-optimized endpoint. The valid value is C<Z2FDTNDATAQYW2> for all | ||
| 66 | the regions. For more information, see Set up a Regional Custom Domain | ||
| 67 | Name | ||
| 68 | (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) | ||
| 69 | and AWS Regions and Endpoints for API Gateway | ||
| 70 | (https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region). | ||
| 71 | |||
| 72 | |||
| 73 | =head2 DomainName => Str | ||
| 74 | |||
| 75 | The custom domain name as an API host name, for example, | ||
| 76 | C<my-api.example.com>. | ||
| 77 | |||
| 78 | |||
| 79 | =head2 DomainNameStatus => Str | ||
| 80 | |||
| 81 | The status of the DomainName migration. The valid values are | ||
| 82 | C<AVAILABLE> and C<UPDATING>. If the status is C<UPDATING>, the domain | ||
| 83 | cannot be modified further until the existing operation is complete. If | ||
| 84 | it is C<AVAILABLE>, the domain can be updated. | ||
| 85 | |||
| 86 | Valid values are: C<"AVAILABLE">, C<"UPDATING">, C<"PENDING"> | ||
| 87 | =head2 DomainNameStatusMessage => Str | ||
| 88 | |||
| 89 | An optional text message containing detailed information about status | ||
| 90 | of the DomainName migration. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 EndpointConfiguration => L<Paws::ApiGateway::EndpointConfiguration> | ||
| 94 | |||
| 95 | The endpoint configuration of this DomainName showing the endpoint | ||
| 96 | types of the domain name. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 MutualTlsAuthentication => L<Paws::ApiGateway::MutualTlsAuthentication> | ||
| 100 | |||
| 101 | The mutual TLS authentication configuration for a custom domain name. | ||
| 102 | If specified, API Gateway performs two-way authentication between the | ||
| 103 | client and the server. Clients must present a trusted certificate to | ||
| 104 | access your API. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 RegionalCertificateArn => Str | ||
| 108 | |||
| 109 | The reference to an AWS-managed certificate that will be used for | ||
| 110 | validating the regional domain name. AWS Certificate Manager is the | ||
| 111 | only supported source. | ||
| 112 | |||
| 113 | |||
| 114 | =head2 RegionalCertificateName => Str | ||
| 115 | |||
| 116 | The name of the certificate that will be used for validating the | ||
| 117 | regional domain name. | ||
| 118 | |||
| 119 | |||
| 120 | =head2 RegionalDomainName => Str | ||
| 121 | |||
| 122 | The domain name associated with the regional endpoint for this custom | ||
| 123 | domain name. You set up this association by adding a DNS record that | ||
| 124 | points the custom domain name to this regional domain name. The | ||
| 125 | regional domain name is returned by API Gateway when you create a | ||
| 126 | regional endpoint. | ||
| 127 | |||
| 128 | |||
| 129 | =head2 RegionalHostedZoneId => Str | ||
| 130 | |||
| 131 | The region-specific Amazon Route 53 Hosted Zone ID of the regional | ||
| 132 | endpoint. For more information, see Set up a Regional Custom Domain | ||
| 133 | Name | ||
| 134 | (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) | ||
| 135 | and AWS Regions and Endpoints for API Gateway | ||
| 136 | (https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region). | ||
| 137 | |||
| 138 | |||
| 139 | =head2 SecurityPolicy => Str | ||
| 140 | |||
| 141 | The Transport Layer Security (TLS) version + cipher suite for this | ||
| 142 | DomainName. The valid values are C<TLS_1_0> and C<TLS_1_2>. | ||
| 143 | |||
| 144 | Valid values are: C<"TLS_1_0">, C<"TLS_1_2"> | ||
| 145 | =head2 Tags => L<Paws::ApiGateway::MapOfStringToString> | ||
| 146 | |||
| 147 | The collection of tags. Each tag element is associated with a given | ||
| 148 | resource. | ||
| 149 | |||
| 150 | |||
| 151 | =head2 _request_id => Str | ||
| 152 | |||
| 153 | |||
| 154 | =cut | ||
| 155 |