« blib/lib/Paws/CloudFront/UpdateStreamingDistributionResult.pm
↑ Summary
blib/lib/Paws/CloudHSM/AddTagsToResource.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudFront::ViewerCertificate; | ||
| 3 | use Moose; | ||
| 4 | has ACMCertificateArn => (is => 'ro', isa => 'Str'); | ||
| 5 | has Certificate => (is => 'ro', isa => 'Str'); | ||
| 6 | has CertificateSource => (is => 'ro', isa => 'Str'); | ||
| 7 | has CloudFrontDefaultCertificate => (is => 'ro', isa => 'Bool'); | ||
| 8 | has IAMCertificateId => (is => 'ro', isa => 'Str'); | ||
| 9 | has MinimumProtocolVersion => (is => 'ro', isa => 'Str'); | ||
| 10 | has SSLSupportMethod => (is => 'ro', isa => 'Str'); | ||
| 11 | |||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::CloudFront::ViewerCertificate | ||
| 19 | |||
| 20 | =head1 USAGE | ||
| 21 | |||
| 22 | This class represents one of two things: | ||
| 23 | |||
| 24 | =head3 Arguments in a call to a service | ||
| 25 | |||
| 26 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 27 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 28 | |||
| 29 | As an example, if Att1 is expected to be a Paws::CloudFront::ViewerCertificate object: | ||
| 30 | |||
| 31 | $service_obj->Method(Att1 => { ACMCertificateArn => $value, ..., SSLSupportMethod => $value }); | ||
| 32 | |||
| 33 | =head3 Results returned from an API call | ||
| 34 | |||
| 35 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudFront::ViewerCertificate object: | ||
| 36 | |||
| 37 | $result = $service_obj->Method(...); | ||
| 38 | $result->Att1->ACMCertificateArn | ||
| 39 | |||
| 40 | =head1 DESCRIPTION | ||
| 41 | |||
| 42 | A complex type that determines the distributionE<rsquo>s SSL/TLS | ||
| 43 | configuration for communicating with viewers. | ||
| 44 | |||
| 45 | If the distribution doesnE<rsquo>t use C<Aliases> (also known as | ||
| 46 | alternate domain names or CNAMEs)E<mdash>that is, if the distribution | ||
| 47 | uses the CloudFront domain name such as | ||
| 48 | C<d111111abcdef8.cloudfront.net>E<mdash>set | ||
| 49 | C<CloudFrontDefaultCertificate> to C<true> and leave all other fields | ||
| 50 | empty. | ||
| 51 | |||
| 52 | If the distribution uses C<Aliases> (alternate domain names or CNAMEs), | ||
| 53 | use the fields in this type to specify the following settings: | ||
| 54 | |||
| 55 | =over | ||
| 56 | |||
| 57 | =item * | ||
| 58 | |||
| 59 | Which viewers the distribution accepts HTTPS connections from: only | ||
| 60 | viewers that support server name indication (SNI) | ||
| 61 | (https://en.wikipedia.org/wiki/Server_Name_Indication) (recommended), | ||
| 62 | or all viewers including those that donE<rsquo>t support SNI. | ||
| 63 | |||
| 64 | =over | ||
| 65 | |||
| 66 | =item * | ||
| 67 | |||
| 68 | To accept HTTPS connections from only viewers that support SNI, set | ||
| 69 | C<SSLSupportMethod> to C<sni-only>. This is recommended. Most browsers | ||
| 70 | and clients support SNI. | ||
| 71 | |||
| 72 | =item * | ||
| 73 | |||
| 74 | To accept HTTPS connections from all viewers, including those that | ||
| 75 | donE<rsquo>t support SNI, set C<SSLSupportMethod> to C<vip>. This is | ||
| 76 | not recommended, and results in additional monthly charges from | ||
| 77 | CloudFront. | ||
| 78 | |||
| 79 | =back | ||
| 80 | |||
| 81 | =item * | ||
| 82 | |||
| 83 | The minimum SSL/TLS protocol version that the distribution can use to | ||
| 84 | communicate with viewers. To specify a minimum version, choose a value | ||
| 85 | for C<MinimumProtocolVersion>. For more information, see Security | ||
| 86 | Policy | ||
| 87 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) | ||
| 88 | in the I<Amazon CloudFront Developer Guide>. | ||
| 89 | |||
| 90 | =item * | ||
| 91 | |||
| 92 | The location of the SSL/TLS certificate, AWS Certificate Manager (ACM) | ||
| 93 | (https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html) | ||
| 94 | (recommended) or AWS Identity and Access Management (AWS IAM) | ||
| 95 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html). | ||
| 96 | You specify the location by setting a value in one of the following | ||
| 97 | fields (not both): | ||
| 98 | |||
| 99 | =over | ||
| 100 | |||
| 101 | =item * | ||
| 102 | |||
| 103 | C<ACMCertificateArn> | ||
| 104 | |||
| 105 | =item * | ||
| 106 | |||
| 107 | C<IAMCertificateId> | ||
| 108 | |||
| 109 | =back | ||
| 110 | |||
| 111 | =back | ||
| 112 | |||
| 113 | All distributions support HTTPS connections from viewers. To require | ||
| 114 | viewers to use HTTPS only, or to redirect them from HTTP to HTTPS, use | ||
| 115 | C<ViewerProtocolPolicy> in the C<CacheBehavior> or | ||
| 116 | C<DefaultCacheBehavior>. To specify how CloudFront should use SSL/TLS | ||
| 117 | to communicate with your custom origin, use C<CustomOriginConfig>. | ||
| 118 | |||
| 119 | For more information, see Using HTTPS with CloudFront | ||
| 120 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https.html) | ||
| 121 | and Using Alternate Domain Names and HTTPS | ||
| 122 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-alternate-domain-names.html) | ||
| 123 | in the I<Amazon CloudFront Developer Guide>. | ||
| 124 | |||
| 125 | =head1 ATTRIBUTES | ||
| 126 | |||
| 127 | |||
| 128 | =head2 ACMCertificateArn => Str | ||
| 129 | |||
| 130 | If the distribution uses C<Aliases> (alternate domain names or CNAMEs) | ||
| 131 | and the SSL/TLS certificate is stored in AWS Certificate Manager (ACM) | ||
| 132 | (https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html), | ||
| 133 | provide the Amazon Resource Name (ARN) of the ACM certificate. | ||
| 134 | CloudFront only supports ACM certificates in the US East (N. Virginia) | ||
| 135 | Region (C<us-east-1>). | ||
| 136 | |||
| 137 | If you specify an ACM certificate ARN, you must also specify values for | ||
| 138 | C<MinimumProtocolVersion> and C<SSLSupportMethod>. | ||
| 139 | |||
| 140 | |||
| 141 | =head2 Certificate => Str | ||
| 142 | |||
| 143 | This field is deprecated. Use one of the following fields instead: | ||
| 144 | |||
| 145 | =over | ||
| 146 | |||
| 147 | =item * | ||
| 148 | |||
| 149 | C<ACMCertificateArn> | ||
| 150 | |||
| 151 | =item * | ||
| 152 | |||
| 153 | C<IAMCertificateId> | ||
| 154 | |||
| 155 | =item * | ||
| 156 | |||
| 157 | C<CloudFrontDefaultCertificate> | ||
| 158 | |||
| 159 | =back | ||
| 160 | |||
| 161 | |||
| 162 | |||
| 163 | =head2 CertificateSource => Str | ||
| 164 | |||
| 165 | This field is deprecated. Use one of the following fields instead: | ||
| 166 | |||
| 167 | =over | ||
| 168 | |||
| 169 | =item * | ||
| 170 | |||
| 171 | C<ACMCertificateArn> | ||
| 172 | |||
| 173 | =item * | ||
| 174 | |||
| 175 | C<IAMCertificateId> | ||
| 176 | |||
| 177 | =item * | ||
| 178 | |||
| 179 | C<CloudFrontDefaultCertificate> | ||
| 180 | |||
| 181 | =back | ||
| 182 | |||
| 183 | |||
| 184 | |||
| 185 | =head2 CloudFrontDefaultCertificate => Bool | ||
| 186 | |||
| 187 | If the distribution uses the CloudFront domain name such as | ||
| 188 | C<d111111abcdef8.cloudfront.net>, set this field to C<true>. | ||
| 189 | |||
| 190 | If the distribution uses C<Aliases> (alternate domain names or CNAMEs), | ||
| 191 | set this field to C<false> and specify values for the following fields: | ||
| 192 | |||
| 193 | =over | ||
| 194 | |||
| 195 | =item * | ||
| 196 | |||
| 197 | C<ACMCertificateArn> or C<IAMCertificateId> (specify a value for one, | ||
| 198 | not both) | ||
| 199 | |||
| 200 | =item * | ||
| 201 | |||
| 202 | C<MinimumProtocolVersion> | ||
| 203 | |||
| 204 | =item * | ||
| 205 | |||
| 206 | C<SSLSupportMethod> | ||
| 207 | |||
| 208 | =back | ||
| 209 | |||
| 210 | |||
| 211 | |||
| 212 | =head2 IAMCertificateId => Str | ||
| 213 | |||
| 214 | If the distribution uses C<Aliases> (alternate domain names or CNAMEs) | ||
| 215 | and the SSL/TLS certificate is stored in AWS Identity and Access | ||
| 216 | Management (AWS IAM) | ||
| 217 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html), | ||
| 218 | provide the ID of the IAM certificate. | ||
| 219 | |||
| 220 | If you specify an IAM certificate ID, you must also specify values for | ||
| 221 | C<MinimumProtocolVersion> and C<SSLSupportMethod>. | ||
| 222 | |||
| 223 | |||
| 224 | =head2 MinimumProtocolVersion => Str | ||
| 225 | |||
| 226 | If the distribution uses C<Aliases> (alternate domain names or CNAMEs), | ||
| 227 | specify the security policy that you want CloudFront to use for HTTPS | ||
| 228 | connections with viewers. The security policy determines two settings: | ||
| 229 | |||
| 230 | =over | ||
| 231 | |||
| 232 | =item * | ||
| 233 | |||
| 234 | The minimum SSL/TLS protocol that CloudFront can use to communicate | ||
| 235 | with viewers. | ||
| 236 | |||
| 237 | =item * | ||
| 238 | |||
| 239 | The ciphers that CloudFront can use to encrypt the content that it | ||
| 240 | returns to viewers. | ||
| 241 | |||
| 242 | =back | ||
| 243 | |||
| 244 | For more information, see Security Policy | ||
| 245 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) | ||
| 246 | and Supported Protocols and Ciphers Between Viewers and CloudFront | ||
| 247 | (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers) | ||
| 248 | in the I<Amazon CloudFront Developer Guide>. | ||
| 249 | |||
| 250 | On the CloudFront console, this setting is called B<Security Policy>. | ||
| 251 | |||
| 252 | When youE<rsquo>re using SNI only (you set C<SSLSupportMethod> to | ||
| 253 | C<sni-only>), you must specify C<TLSv1> or higher. | ||
| 254 | |||
| 255 | If the distribution uses the CloudFront domain name such as | ||
| 256 | C<d111111abcdef8.cloudfront.net> (you set | ||
| 257 | C<CloudFrontDefaultCertificate> to C<true>), CloudFront automatically | ||
| 258 | sets the security policy to C<TLSv1> regardless of the value that you | ||
| 259 | set here. | ||
| 260 | |||
| 261 | |||
| 262 | =head2 SSLSupportMethod => Str | ||
| 263 | |||
| 264 | If the distribution uses C<Aliases> (alternate domain names or CNAMEs), | ||
| 265 | specify which viewers the distribution accepts HTTPS connections from. | ||
| 266 | |||
| 267 | =over | ||
| 268 | |||
| 269 | =item * | ||
| 270 | |||
| 271 | C<sni-only> E<ndash> The distribution accepts HTTPS connections from | ||
| 272 | only viewers that support server name indication (SNI) | ||
| 273 | (https://en.wikipedia.org/wiki/Server_Name_Indication). This is | ||
| 274 | recommended. Most browsers and clients support SNI. | ||
| 275 | |||
| 276 | =item * | ||
| 277 | |||
| 278 | C<vip> E<ndash> The distribution accepts HTTPS connections from all | ||
| 279 | viewers including those that donE<rsquo>t support SNI. This is not | ||
| 280 | recommended, and results in additional monthly charges from CloudFront. | ||
| 281 | |||
| 282 | =item * | ||
| 283 | |||
| 284 | C<static-ip> - Do not specify this value unless your distribution has | ||
| 285 | been enabled for this feature by the CloudFront team. If you have a use | ||
| 286 | case that requires static IP addresses for a distribution, contact | ||
| 287 | CloudFront through the AWS Support Center | ||
| 288 | (https://console.aws.amazon.com/support/home). | ||
| 289 | |||
| 290 | =back | ||
| 291 | |||
| 292 | If the distribution uses the CloudFront domain name such as | ||
| 293 | C<d111111abcdef8.cloudfront.net>, donE<rsquo>t set a value for this | ||
| 294 | field. | ||
| 295 | |||
| 296 | |||
| 297 | |||
| 298 | =head1 SEE ALSO | ||
| 299 | |||
| 300 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudFront> | ||
| 301 | |||
| 302 | =head1 BUGS and CONTRIBUTIONS | ||
| 303 | |||
| 304 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 305 | |||
| 306 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 307 | |||
| 308 | =cut | ||
| 309 |