Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CloudFront.Types.ViewerCertificate

Description

Synopsis

Documentation

data ViewerCertificate Source #

A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.

If the distribution doesn't use Aliases (also known as alternate domain names or CNAMEs)—that is, if the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net—set CloudFrontDefaultCertificate to true and leave all other fields empty.

If the distribution uses Aliases (alternate domain names or CNAMEs), use the fields in this type to specify the following settings:

Which viewers the distribution accepts HTTPS connections from: only viewers that support server name indication (SNI) (recommended), or all viewers including those that don't support SNI.
- To accept HTTPS connections from only viewers that support SNI, set SSLSupportMethod to sni-only. This is recommended. Most browsers and clients support SNI.
- To accept HTTPS connections from all viewers, including those that don't support SNI, set SSLSupportMethod to vip. This is not recommended, and results in additional monthly charges from CloudFront.
The minimum SSL/TLS protocol version that the distribution can use to communicate with viewers. To specify a minimum version, choose a value for MinimumProtocolVersion. For more information, see Security Policy in the Amazon CloudFront Developer Guide.
The location of the SSL/TLS certificate, Certificate Manager (ACM) (recommended) or Identity and Access Management (IAM). You specify the location by setting a value in one of the following fields (not both):
- ```
ACMCertificateArn
```
- ```
IAMCertificateId
```

All distributions support HTTPS connections from viewers. To require viewers to use HTTPS only, or to redirect them from HTTP to HTTPS, use ViewerProtocolPolicy in the CacheBehavior or DefaultCacheBehavior. To specify how CloudFront should use SSL/TLS to communicate with your custom origin, use CustomOriginConfig.

For more information, see Using HTTPS with CloudFront and Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide.

See: newViewerCertificate smart constructor.

Constructors

ViewerCertificate'

Fields

aCMCertificateArn :: Maybe Text
If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Certificate Manager (ACM), provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (us-east-1).
If you specify an ACM certificate ARN, you must also specify values for MinimumProtocolVersion and SSLSupportMethod.
certificate :: Maybe Text
This field is deprecated. Use one of the following fields instead:
- ```
ACMCertificateArn
```
- ```
IAMCertificateId
```
- ```
CloudFrontDefaultCertificate
```
certificateSource :: Maybe CertificateSource
This field is deprecated. Use one of the following fields instead:
- ```
ACMCertificateArn
```
- ```
IAMCertificateId
```
- ```
CloudFrontDefaultCertificate
```
cloudFrontDefaultCertificate :: Maybe Bool
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net, set this field to true.
If the distribution uses Aliases (alternate domain names or CNAMEs), set this field to false and specify values for the following fields:
- ACMCertificateArn or IAMCertificateId (specify a value for one, not both)
- ```
MinimumProtocolVersion
```
- ```
SSLSupportMethod
```
iAMCertificateId :: Maybe Text
If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Identity and Access Management (IAM), provide the ID of the IAM certificate.
If you specify an IAM certificate ID, you must also specify values for MinimumProtocolVersion and SSLSupportMethod.
minimumProtocolVersion :: Maybe MinimumProtocolVersion
If the distribution uses Aliases (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:
- The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers.
- The ciphers that CloudFront can use to encrypt the content that it returns to viewers.
For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.
On the CloudFront console, this setting is called Security Policy.
When you're using SNI only (you set SSLSupportMethod to sni-only), you must specify TLSv1 or higher.
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net (you set CloudFrontDefaultCertificate to true), CloudFront automatically sets the security policy to TLSv1 regardless of the value that you set here.
sSLSupportMethod :: Maybe SSLSupportMethod
If the distribution uses Aliases (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.
- sni-only – The distribution accepts HTTPS connections from only viewers that support server name indication (SNI). This is recommended. Most browsers and clients support SNI.
- vip – The distribution accepts HTTPS connections from all viewers including those that don't support SNI. This is not recommended, and results in additional monthly charges from CloudFront.
- static-ip - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the Amazon Web Services Support Center.
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net, don't set a value for this field.

Instances

Instances details

FromXML ViewerCertificate Source #
Instance details Defined in Amazonka.CloudFront.Types.ViewerCertificate Methods parseXML :: [Node] -> Either String ViewerCertificate #
ToXML ViewerCertificate Source #
Instance details Defined in Amazonka.CloudFront.Types.ViewerCertificate Methods toXML :: ViewerCertificate -> XML #
Generic ViewerCertificate Source #
Instance details Defined in Amazonka.CloudFront.Types.ViewerCertificate Associated Types type Rep ViewerCertificate :: Type -> Type # Methods from :: ViewerCertificate -> Rep ViewerCertificate x # to :: Rep ViewerCertificate x -> ViewerCertificate #
Read ViewerCertificate Source #
Instance details Defined in Amazonka.CloudFront.Types.ViewerCertificate Methods readsPrec :: Int -> ReadS ViewerCertificate # readList :: ReadS [ViewerCertificate] # readPrec :: ReadPrec ViewerCertificate # readListPrec :: ReadPrec [ViewerCertificate] #
Show ViewerCertificate Source #
Instance details Defined in Amazonka.CloudFront.Types.ViewerCertificate Methods showsPrec :: Int -> ViewerCertificate -> ShowS # show :: ViewerCertificate -> String # showList :: [ViewerCertificate] -> ShowS #
NFData ViewerCertificate Source #
Instance details Defined in Amazonka.CloudFront.Types.ViewerCertificate Methods rnf :: ViewerCertificate -> () #
Eq ViewerCertificate Source #
Instance details Defined in Amazonka.CloudFront.Types.ViewerCertificate Methods (==) :: ViewerCertificate -> ViewerCertificate -> Bool # (/=) :: ViewerCertificate -> ViewerCertificate -> Bool #
Hashable ViewerCertificate Source #
Instance details Defined in Amazonka.CloudFront.Types.ViewerCertificate Methods hashWithSalt :: Int -> ViewerCertificate -> Int # hash :: ViewerCertificate -> Int #
type Rep ViewerCertificate Source #
Instance details Defined in Amazonka.CloudFront.Types.ViewerCertificate type Rep ViewerCertificate = D1 ('MetaData "ViewerCertificate" "Amazonka.CloudFront.Types.ViewerCertificate" "amazonka-cloudfront-2.0-8Jb7luniAuUfLdUxCxW4K" 'False) (C1 ('MetaCons "ViewerCertificate'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "aCMCertificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "certificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "certificateSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CertificateSource)))) :: ((S1 ('MetaSel ('Just "cloudFrontDefaultCertificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "iAMCertificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "minimumProtocolVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MinimumProtocolVersion)) :: S1 ('MetaSel ('Just "sSLSupportMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SSLSupportMethod))))))

newViewerCertificate :: ViewerCertificate Source #

Create a value of ViewerCertificate with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:aCMCertificateArn:ViewerCertificate', viewerCertificate_aCMCertificateArn - If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Certificate Manager (ACM), provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (us-east-1).

If you specify an ACM certificate ARN, you must also specify values for MinimumProtocolVersion and SSLSupportMethod.

$sel:certificate:ViewerCertificate', viewerCertificate_certificate - This field is deprecated. Use one of the following fields instead:

```
ACMCertificateArn
```
```
IAMCertificateId
```
```
CloudFrontDefaultCertificate
```

$sel:certificateSource:ViewerCertificate', viewerCertificate_certificateSource - This field is deprecated. Use one of the following fields instead:

```
ACMCertificateArn
```
```
IAMCertificateId
```
```
CloudFrontDefaultCertificate
```

$sel:cloudFrontDefaultCertificate:ViewerCertificate', viewerCertificate_cloudFrontDefaultCertificate - If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net, set this field to true.

If the distribution uses Aliases (alternate domain names or CNAMEs), set this field to false and specify values for the following fields:

ACMCertificateArn or IAMCertificateId (specify a value for one, not both)
```
MinimumProtocolVersion
```
```
SSLSupportMethod
```

$sel:iAMCertificateId:ViewerCertificate', viewerCertificate_iAMCertificateId - If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Identity and Access Management (IAM), provide the ID of the IAM certificate.

If you specify an IAM certificate ID, you must also specify values for MinimumProtocolVersion and SSLSupportMethod.

$sel:minimumProtocolVersion:ViewerCertificate', viewerCertificate_minimumProtocolVersion - If the distribution uses Aliases (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:

The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers.
The ciphers that CloudFront can use to encrypt the content that it returns to viewers.

For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

On the CloudFront console, this setting is called Security Policy.

When you're using SNI only (you set SSLSupportMethod to sni-only), you must specify TLSv1 or higher.

If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net (you set CloudFrontDefaultCertificate to true), CloudFront automatically sets the security policy to TLSv1 regardless of the value that you set here.

$sel:sSLSupportMethod:ViewerCertificate', viewerCertificate_sSLSupportMethod - If the distribution uses Aliases (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.

sni-only – The distribution accepts HTTPS connections from only viewers that support server name indication (SNI). This is recommended. Most browsers and clients support SNI.
vip – The distribution accepts HTTPS connections from all viewers including those that don't support SNI. This is not recommended, and results in additional monthly charges from CloudFront.
static-ip - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the Amazon Web Services Support Center.

If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net, don't set a value for this field.

viewerCertificate_aCMCertificateArn :: Lens' ViewerCertificate (Maybe Text) Source #

If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Certificate Manager (ACM), provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (us-east-1).

If you specify an ACM certificate ARN, you must also specify values for MinimumProtocolVersion and SSLSupportMethod.

viewerCertificate_certificate :: Lens' ViewerCertificate (Maybe Text) Source #

This field is deprecated. Use one of the following fields instead:

```
ACMCertificateArn
```
```
IAMCertificateId
```
```
CloudFrontDefaultCertificate
```

viewerCertificate_certificateSource :: Lens' ViewerCertificate (Maybe CertificateSource) Source #

This field is deprecated. Use one of the following fields instead:

```
ACMCertificateArn
```
```
IAMCertificateId
```
```
CloudFrontDefaultCertificate
```

viewerCertificate_cloudFrontDefaultCertificate :: Lens' ViewerCertificate (Maybe Bool) Source #

If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net, set this field to true.

If the distribution uses Aliases (alternate domain names or CNAMEs), set this field to false and specify values for the following fields:

ACMCertificateArn or IAMCertificateId (specify a value for one, not both)
```
MinimumProtocolVersion
```
```
SSLSupportMethod
```

viewerCertificate_iAMCertificateId :: Lens' ViewerCertificate (Maybe Text) Source #

If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in Identity and Access Management (IAM), provide the ID of the IAM certificate.

If you specify an IAM certificate ID, you must also specify values for MinimumProtocolVersion and SSLSupportMethod.

viewerCertificate_minimumProtocolVersion :: Lens' ViewerCertificate (Maybe MinimumProtocolVersion) Source #

If the distribution uses Aliases (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:

The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers.
The ciphers that CloudFront can use to encrypt the content that it returns to viewers.

For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

On the CloudFront console, this setting is called Security Policy.

When you're using SNI only (you set SSLSupportMethod to sni-only), you must specify TLSv1 or higher.

If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net (you set CloudFrontDefaultCertificate to true), CloudFront automatically sets the security policy to TLSv1 regardless of the value that you set here.

viewerCertificate_sSLSupportMethod :: Lens' ViewerCertificate (Maybe SSLSupportMethod) Source #

If the distribution uses Aliases (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.

sni-only – The distribution accepts HTTPS connections from only viewers that support server name indication (SNI). This is recommended. Most browsers and clients support SNI.
vip – The distribution accepts HTTPS connections from all viewers including those that don't support SNI. This is not recommended, and results in additional monthly charges from CloudFront.
static-ip - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the Amazon Web Services Support Center.

If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net, don't set a value for this field.