« blib/lib/Paws/ApiGateway/CreateDocumentationVersion.pm
↑ Summary
blib/lib/Paws/ApiGateway/CreateModel.pm »
| 1 | |||
| 2 | package Paws::ApiGateway::CreateDomainName; | ||
| 3 | use Moose; | ||
| 4 | has CertificateArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'certificateArn'); | ||
| 5 | has CertificateBody => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'certificateBody'); | ||
| 6 | has CertificateChain => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'certificateChain'); | ||
| 7 | has CertificateName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'certificateName'); | ||
| 8 | has CertificatePrivateKey => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'certificatePrivateKey'); | ||
| 9 | has DomainName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'domainName', required => 1); | ||
| 10 | has EndpointConfiguration => (is => 'ro', isa => 'Paws::ApiGateway::EndpointConfiguration', traits => ['NameInRequest'], request_name => 'endpointConfiguration'); | ||
| 11 | has MutualTlsAuthentication => (is => 'ro', isa => 'Paws::ApiGateway::MutualTlsAuthenticationInput', traits => ['NameInRequest'], request_name => 'mutualTlsAuthentication'); | ||
| 12 | has RegionalCertificateArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'regionalCertificateArn'); | ||
| 13 | has RegionalCertificateName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'regionalCertificateName'); | ||
| 14 | has SecurityPolicy => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'securityPolicy'); | ||
| 15 | has Tags => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToString', traits => ['NameInRequest'], request_name => 'tags'); | ||
| 16 | |||
| 17 | use MooseX::ClassAttribute; | ||
| 18 | |||
| 19 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateDomainName'); | ||
| 20 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/domainnames'); | ||
| 21 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 22 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::DomainName'); | ||
| 23 | 1; | ||
| 24 | |||
| 25 | ### main pod documentation begin ### | ||
| 26 | |||
| 27 | =head1 NAME | ||
| 28 | |||
| 29 | Paws::ApiGateway::CreateDomainName - Arguments for method CreateDomainName on L<Paws::ApiGateway> | ||
| 30 | |||
| 31 | =head1 DESCRIPTION | ||
| 32 | |||
| 33 | This class represents the parameters used for calling the method CreateDomainName on the | ||
| 34 | L<Amazon API Gateway|Paws::ApiGateway> service. Use the attributes of this class | ||
| 35 | as arguments to method CreateDomainName. | ||
| 36 | |||
| 37 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateDomainName. | ||
| 38 | |||
| 39 | =head1 SYNOPSIS | ||
| 40 | |||
| 41 | my $apigateway = Paws->service('ApiGateway'); | ||
| 42 | my $DomainName = $apigateway->CreateDomainName( | ||
| 43 | DomainName => 'MyString', | ||
| 44 | CertificateArn => 'MyString', # OPTIONAL | ||
| 45 | CertificateBody => 'MyString', # OPTIONAL | ||
| 46 | CertificateChain => 'MyString', # OPTIONAL | ||
| 47 | CertificateName => 'MyString', # OPTIONAL | ||
| 48 | CertificatePrivateKey => 'MyString', # OPTIONAL | ||
| 49 | EndpointConfiguration => { | ||
| 50 | Types => [ | ||
| 51 | 'REGIONAL', ... # values: REGIONAL, EDGE, PRIVATE | ||
| 52 | ], # OPTIONAL | ||
| 53 | VpcEndpointIds => [ 'MyString', ... ], # OPTIONAL | ||
| 54 | }, # OPTIONAL | ||
| 55 | MutualTlsAuthentication => { | ||
| 56 | TruststoreUri => 'MyString', | ||
| 57 | TruststoreVersion => 'MyString', | ||
| 58 | }, # OPTIONAL | ||
| 59 | RegionalCertificateArn => 'MyString', # OPTIONAL | ||
| 60 | RegionalCertificateName => 'MyString', # OPTIONAL | ||
| 61 | SecurityPolicy => 'TLS_1_0', # OPTIONAL | ||
| 62 | Tags => { 'MyString' => 'MyString', }, # OPTIONAL | ||
| 63 | ); | ||
| 64 | |||
| 65 | # Results: | ||
| 66 | my $CertificateArn = $DomainName->CertificateArn; | ||
| 67 | my $CertificateName = $DomainName->CertificateName; | ||
| 68 | my $CertificateUploadDate = $DomainName->CertificateUploadDate; | ||
| 69 | my $DistributionDomainName = $DomainName->DistributionDomainName; | ||
| 70 | my $DistributionHostedZoneId = $DomainName->DistributionHostedZoneId; | ||
| 71 | my $DomainName = $DomainName->DomainName; | ||
| 72 | my $DomainNameStatus = $DomainName->DomainNameStatus; | ||
| 73 | my $DomainNameStatusMessage = $DomainName->DomainNameStatusMessage; | ||
| 74 | my $EndpointConfiguration = $DomainName->EndpointConfiguration; | ||
| 75 | my $MutualTlsAuthentication = $DomainName->MutualTlsAuthentication; | ||
| 76 | my $RegionalCertificateArn = $DomainName->RegionalCertificateArn; | ||
| 77 | my $RegionalCertificateName = $DomainName->RegionalCertificateName; | ||
| 78 | my $RegionalDomainName = $DomainName->RegionalDomainName; | ||
| 79 | my $RegionalHostedZoneId = $DomainName->RegionalHostedZoneId; | ||
| 80 | my $SecurityPolicy = $DomainName->SecurityPolicy; | ||
| 81 | my $Tags = $DomainName->Tags; | ||
| 82 | |||
| 83 | # Returns a L<Paws::ApiGateway::DomainName> object. | ||
| 84 | |||
| 85 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 86 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/apigateway/CreateDomainName> | ||
| 87 | |||
| 88 | =head1 ATTRIBUTES | ||
| 89 | |||
| 90 | |||
| 91 | =head2 CertificateArn => Str | ||
| 92 | |||
| 93 | The reference to an AWS-managed certificate that will be used by | ||
| 94 | edge-optimized endpoint for this domain name. AWS Certificate Manager | ||
| 95 | is the only supported source. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 CertificateBody => Str | ||
| 100 | |||
| 101 | [Deprecated] The body of the server certificate that will be used by | ||
| 102 | edge-optimized endpoint for this domain name provided by your | ||
| 103 | certificate authority. | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head2 CertificateChain => Str | ||
| 108 | |||
| 109 | [Deprecated] The intermediate certificates and optionally the root | ||
| 110 | certificate, one after the other without any blank lines, used by an | ||
| 111 | edge-optimized endpoint for this domain name. If you include the root | ||
| 112 | certificate, your certificate chain must start with intermediate | ||
| 113 | certificates and end with the root certificate. Use the intermediate | ||
| 114 | certificates that were provided by your certificate authority. Do not | ||
| 115 | include any intermediaries that are not in the chain of trust path. | ||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | =head2 CertificateName => Str | ||
| 120 | |||
| 121 | The user-friendly name of the certificate that will be used by | ||
| 122 | edge-optimized endpoint for this domain name. | ||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | =head2 CertificatePrivateKey => Str | ||
| 127 | |||
| 128 | [Deprecated] Your edge-optimized endpoint's domain name certificate's | ||
| 129 | private key. | ||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | =head2 B<REQUIRED> DomainName => Str | ||
| 134 | |||
| 135 | [Required] The name of the DomainName resource. | ||
| 136 | |||
| 137 | |||
| 138 | |||
| 139 | =head2 EndpointConfiguration => L<Paws::ApiGateway::EndpointConfiguration> | ||
| 140 | |||
| 141 | The endpoint configuration of this DomainName showing the endpoint | ||
| 142 | types of the domain name. | ||
| 143 | |||
| 144 | |||
| 145 | |||
| 146 | =head2 MutualTlsAuthentication => L<Paws::ApiGateway::MutualTlsAuthenticationInput> | ||
| 147 | |||
| 148 | |||
| 149 | |||
| 150 | |||
| 151 | |||
| 152 | =head2 RegionalCertificateArn => Str | ||
| 153 | |||
| 154 | The reference to an AWS-managed certificate that will be used by | ||
| 155 | regional endpoint for this domain name. AWS Certificate Manager is the | ||
| 156 | only supported source. | ||
| 157 | |||
| 158 | |||
| 159 | |||
| 160 | =head2 RegionalCertificateName => Str | ||
| 161 | |||
| 162 | The user-friendly name of the certificate that will be used by regional | ||
| 163 | endpoint for this domain name. | ||
| 164 | |||
| 165 | |||
| 166 | |||
| 167 | =head2 SecurityPolicy => Str | ||
| 168 | |||
| 169 | The Transport Layer Security (TLS) version + cipher suite for this | ||
| 170 | DomainName. The valid values are C<TLS_1_0> and C<TLS_1_2>. | ||
| 171 | |||
| 172 | Valid values are: C<"TLS_1_0">, C<"TLS_1_2"> | ||
| 173 | |||
| 174 | =head2 Tags => L<Paws::ApiGateway::MapOfStringToString> | ||
| 175 | |||
| 176 | The key-value map of strings. The valid character set is | ||
| 177 | [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not | ||
| 178 | start with C<aws:>. The tag value can be up to 256 characters. | ||
| 179 | |||
| 180 | |||
| 181 | |||
| 182 | |||
| 183 | =head1 SEE ALSO | ||
| 184 | |||
| 185 | This class forms part of L<Paws>, documenting arguments for method CreateDomainName in L<Paws::ApiGateway> | ||
| 186 | |||
| 187 | =head1 BUGS and CONTRIBUTIONS | ||
| 188 | |||
| 189 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 190 | |||
| 191 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 192 | |||
| 193 | =cut | ||
| 194 |