Class CfnDistribution.ViewerCertificateProperty
A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.CloudFront
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ViewerCertificateProperty : Object, CfnDistribution.IViewerCertificateProperty
Syntax (vb)
Public Class ViewerCertificateProperty
Inherits Object
Implements CfnDistribution.IViewerCertificateProperty
Remarks
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:
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 .
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CloudFront;
var viewerCertificateProperty = new ViewerCertificateProperty {
AcmCertificateArn = "acmCertificateArn",
CloudFrontDefaultCertificate = false,
IamCertificateId = "iamCertificateId",
MinimumProtocolVersion = "minimumProtocolVersion",
SslSupportMethod = "sslSupportMethod"
};
Synopsis
Constructors
ViewerCertificateProperty() |
Properties
AcmCertificateArn | In CloudFormation, this field name is |
CloudFrontDefaultCertificate | If the distribution uses the CloudFront domain name such as |
IamCertificateId | In CloudFormation, this field name is |
MinimumProtocolVersion | If the distribution uses |
SslSupportMethod | In CloudFormation, this field name is |
Constructors
ViewerCertificateProperty()
public ViewerCertificateProperty()
Properties
AcmCertificateArn
In CloudFormation, this field name is
AcmCertificateArn
. Note the different capitalization.
public string AcmCertificateArn { get; set; }
Property Value
System.String
Remarks
If the distribution uses Aliases
(alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in AWS 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
. (In CloudFormation, the field name is SslSupportMethod
. Note the different capitalization.)
CloudFrontDefaultCertificate
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net
, set this field to true
.
public object CloudFrontDefaultCertificate { get; set; }
Property Value
System.Object
Remarks
If the distribution uses Aliases
(alternate domain names or CNAMEs), omit this field and specify values for the following fields:
IamCertificateId
In CloudFormation, this field name is
IamCertificateId
. Note the different capitalization.
public string IamCertificateId { get; set; }
Property Value
System.String
Remarks
If the distribution uses Aliases
(alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in AWS 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
. (In CloudFormation, the field name is SslSupportMethod
. Note the different capitalization.)
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.
public string MinimumProtocolVersion { get; set; }
Property Value
System.String
Remarks
The security policy determines two settings:
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 <em>Security Policy</em> .
When you're using SNI only (you set SSLSupportMethod
to sni-only
), you must specify TLSv1
or higher. (In CloudFormation, the field name is SslSupportMethod
. Note the different capitalization.)
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
In CloudFormation, this field name is
SslSupportMethod
. Note the different capitalization.
public string SslSupportMethod { get; set; }
Property Value
System.String
Remarks
If the distribution uses Aliases
(alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.
If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net
, don't set a value for this field.