Show / Hide Table of Contents

Class ViewerCertificate

Viewer certificate configuration class.

Inheritance
object
ViewerCertificate
Namespace: Amazon.CDK.AWS.CloudFront
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ViewerCertificate : DeputyBase
Syntax (vb)
Public Class ViewerCertificate Inherits DeputyBase
Remarks

ExampleMetadata: lit=aws-cloudfront/test/example.iam-cert-alias.lit.ts infused

Examples
var s3BucketSource = new Bucket(this, "Bucket");

            var distribution = new CloudFrontWebDistribution(this, "AnAmazingWebsiteProbably", new CloudFrontWebDistributionProps {
                OriginConfigs = new [] { new SourceConfiguration {
                    S3OriginSource = new S3OriginConfig { S3BucketSource = s3BucketSource },
                    Behaviors = new [] { new Behavior { IsDefaultBehavior = true } }
                } },
                ViewerCertificate = ViewerCertificate.FromIamCertificate("certificateId", new ViewerCertificateOptions {
                    Aliases = new [] { "example.com" },
                    SecurityPolicy = SecurityPolicyProtocol.SSL_V3,  // default
                    SslMethod = SSLMethod.SNI
                })
            });

Synopsis

Properties

Aliases

Viewer certificate configuration class.

Props

Viewer certificate configuration class.

Methods

FromAcmCertificate(ICertificateRef, IViewerCertificateOptions?)

Generate an AWS Certificate Manager (ACM) viewer certificate configuration.

FromCloudFrontDefaultCertificate(params string[])

Generate a viewer certificate configuration using the CloudFront default certificate (e.g. d111111abcdef8.cloudfront.net) and a SecurityPolicyProtocol.TLS_V1 security policy.

FromIamCertificate(string, IViewerCertificateOptions?)

Generate an IAM viewer certificate configuration.

Properties

Aliases

Viewer certificate configuration class.

public virtual string[] Aliases { get; }
Property Value

string[]

Remarks

ExampleMetadata: lit=aws-cloudfront/test/example.iam-cert-alias.lit.ts infused

Examples
var s3BucketSource = new Bucket(this, "Bucket");

            var distribution = new CloudFrontWebDistribution(this, "AnAmazingWebsiteProbably", new CloudFrontWebDistributionProps {
                OriginConfigs = new [] { new SourceConfiguration {
                    S3OriginSource = new S3OriginConfig { S3BucketSource = s3BucketSource },
                    Behaviors = new [] { new Behavior { IsDefaultBehavior = true } }
                } },
                ViewerCertificate = ViewerCertificate.FromIamCertificate("certificateId", new ViewerCertificateOptions {
                    Aliases = new [] { "example.com" },
                    SecurityPolicy = SecurityPolicyProtocol.SSL_V3,  // default
                    SslMethod = SSLMethod.SNI
                })
            });

Props

Viewer certificate configuration class.

public virtual CfnDistribution.IViewerCertificateProperty Props { get; }
Property Value

CfnDistribution.IViewerCertificateProperty

Remarks

ExampleMetadata: lit=aws-cloudfront/test/example.iam-cert-alias.lit.ts infused

Examples
var s3BucketSource = new Bucket(this, "Bucket");

            var distribution = new CloudFrontWebDistribution(this, "AnAmazingWebsiteProbably", new CloudFrontWebDistributionProps {
                OriginConfigs = new [] { new SourceConfiguration {
                    S3OriginSource = new S3OriginConfig { S3BucketSource = s3BucketSource },
                    Behaviors = new [] { new Behavior { IsDefaultBehavior = true } }
                } },
                ViewerCertificate = ViewerCertificate.FromIamCertificate("certificateId", new ViewerCertificateOptions {
                    Aliases = new [] { "example.com" },
                    SecurityPolicy = SecurityPolicyProtocol.SSL_V3,  // default
                    SslMethod = SSLMethod.SNI
                })
            });

Methods

FromAcmCertificate(ICertificateRef, IViewerCertificateOptions?)

Generate an AWS Certificate Manager (ACM) viewer certificate configuration.

public static ViewerCertificate FromAcmCertificate(ICertificateRef certificate, IViewerCertificateOptions? options = null)
Parameters
certificate ICertificateRef

AWS Certificate Manager (ACM) certificate.

options IViewerCertificateOptions

certificate configuration options.

Returns

ViewerCertificate

Remarks

ExampleMetadata: lit=aws-cloudfront/test/example.iam-cert-alias.lit.ts infused

FromCloudFrontDefaultCertificate(params string[])

Generate a viewer certificate configuration using the CloudFront default certificate (e.g. d111111abcdef8.cloudfront.net) and a SecurityPolicyProtocol.TLS_V1 security policy.

public static ViewerCertificate FromCloudFrontDefaultCertificate(params string[] aliases)
Parameters
aliases string[]

Alternative CNAME aliases You also must create a CNAME record with your DNS service to route queries.

Returns

ViewerCertificate

Remarks

ExampleMetadata: lit=aws-cloudfront/test/example.iam-cert-alias.lit.ts infused

FromIamCertificate(string, IViewerCertificateOptions?)

Generate an IAM viewer certificate configuration.

public static ViewerCertificate FromIamCertificate(string iamCertificateId, IViewerCertificateOptions? options = null)
Parameters
iamCertificateId string

Identifier of the IAM certificate.

options IViewerCertificateOptions

certificate configuration options.

Returns

ViewerCertificate

Remarks

ExampleMetadata: lit=aws-cloudfront/test/example.iam-cert-alias.lit.ts infused

Back to top Generated by DocFX