aws-cdk-lib.aws_cloudfront.ViewerCertificate

class ViewerCertificate

LanguageType name
.NETAmazon.CDK.AWS.CloudFront.ViewerCertificate
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscloudfront#ViewerCertificate
Javasoftware.amazon.awscdk.services.cloudfront.ViewerCertificate
Pythonaws_cdk.aws_cloudfront.ViewerCertificate
TypeScript (source)aws-cdk-lib » aws_cloudfront » ViewerCertificate

Viewer certificate configuration class.

Example

    const s3BucketSource = new s3.Bucket(this, 'Bucket');

    const distribution = new cloudfront.CloudFrontWebDistribution(this, 'AnAmazingWebsiteProbably', {
      originConfigs: [{
        s3OriginSource: { s3BucketSource },
        behaviors: [{ isDefaultBehavior: true }],
      }],
      viewerCertificate: cloudfront.ViewerCertificate.fromIamCertificate(
        'certificateId',
        {
          aliases: ['example.com'],
          securityPolicy: cloudfront.SecurityPolicyProtocol.SSL_V3, // default
          sslMethod: cloudfront.SSLMethod.SNI, // default
        },
      ),
    });

Properties

NameTypeDescription
aliasesstring[]
propsViewerCertificateProperty

aliases

Type: string[]


props

Type: ViewerCertificateProperty

Methods

NameDescription
static fromAcmCertificate(certificate, options?)Generate an AWS Certificate Manager (ACM) viewer certificate configuration.
static fromCloudFrontDefaultCertificate(...aliases)Generate a viewer certifcate configuration using the CloudFront default certificate (e.g. d111111abcdef8.cloudfront.net) and a SecurityPolicyProtocol.TLS_V1 security policy.
static fromIamCertificate(iamCertificateId, options?)Generate an IAM viewer certificate configuration.

static fromAcmCertificate(certificate, options?)

public static fromAcmCertificate(certificate: ICertificate, options?: ViewerCertificateOptions): ViewerCertificate

Parameters

  • certificate ICertificate — AWS Certificate Manager (ACM) certificate.
  • options ViewerCertificateOptions — certificate configuration options.

Returns

  • ViewerCertificate

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


static fromCloudFrontDefaultCertificate(...aliases)

public static fromCloudFrontDefaultCertificate(...aliases: string[]): ViewerCertificate

Parameters

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

Returns

  • ViewerCertificate

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


static fromIamCertificate(iamCertificateId, options?)

public static fromIamCertificate(iamCertificateId: string, options?: ViewerCertificateOptions): ViewerCertificate

Parameters

  • iamCertificateId string — Identifier of the IAM certificate.
  • options ViewerCertificateOptions — certificate configuration options.

Returns

  • ViewerCertificate

Generate an IAM viewer certificate configuration.