software.amazon.awssdk.services.cloudfront.model

Interface ViewerCertificate.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ViewerCertificate.Builder,ViewerCertificate>, SdkBuilder<ViewerCertificate.Builder,ViewerCertificate>, SdkPojo

Enclosing class:

ViewerCertificate

public static interface ViewerCertificate.Builder
extends SdkPojo, CopyableBuilder<ViewerCertificate.Builder,ViewerCertificate>

Method Summary

Modifier and Type	Method and Description
ViewerCertificate.Builder	acmCertificateArn(String acmCertificateArn) 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.
ViewerCertificate.Builder	certificate(String certificate) This field is deprecated.
ViewerCertificate.Builder	certificateSource(CertificateSource certificateSource) This field is deprecated.
ViewerCertificate.Builder	certificateSource(String certificateSource) This field is deprecated.
ViewerCertificate.Builder	cloudFrontDefaultCertificate(Boolean cloudFrontDefaultCertificate) If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net, set this field to true.
ViewerCertificate.Builder	iamCertificateId(String iamCertificateId) If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in AWS Identity and Access Management (AWS IAM), provide the ID of the IAM certificate.
ViewerCertificate.Builder	minimumProtocolVersion(MinimumProtocolVersion 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.
ViewerCertificate.Builder	minimumProtocolVersion(String 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.
ViewerCertificate.Builder	sslSupportMethod(SSLSupportMethod sslSupportMethod) If the distribution uses Aliases (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.
ViewerCertificate.Builder	sslSupportMethod(String sslSupportMethod) If the distribution uses Aliases (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

cloudFrontDefaultCertificate

ViewerCertificate.Builder cloudFrontDefaultCertificate(Boolean 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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

iamCertificateId

ViewerCertificate.Builder iamCertificateId(String iamCertificateId)

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

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

Parameters:

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

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

Returns:

Returns a reference to this object so that method calls can be chained together.

acmCertificateArn

ViewerCertificate.Builder acmCertificateArn(String acmCertificateArn)

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 MinimumProtocolVerison and SSLSupportMethod.

Parameters:

acmCertificateArn - 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 MinimumProtocolVerison and SSLSupportMethod.

Returns:

Returns a reference to this object so that method calls can be chained together.

sslSupportMethod

ViewerCertificate.Builder sslSupportMethod(String 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 released after 2010 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.

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

Parameters:

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 released after 2010 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.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SSLSupportMethod, SSLSupportMethod

sslSupportMethod

ViewerCertificate.Builder sslSupportMethod(SSLSupportMethod 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 released after 2010 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.

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

Parameters:

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 released after 2010 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.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SSLSupportMethod, SSLSupportMethod

minimumProtocolVersion

ViewerCertificate.Builder minimumProtocolVersion(String 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.

We recommend that you specify TLSv1.2_2018 unless your viewers are using browsers or devices that don’t support TLSv1.2.

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.

Parameters:

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.

We recommend that you specify TLSv1.2_2018 unless your viewers are using browsers or devices that don’t support TLSv1.2.

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MinimumProtocolVersion, MinimumProtocolVersion

minimumProtocolVersion

ViewerCertificate.Builder minimumProtocolVersion(MinimumProtocolVersion 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.

We recommend that you specify TLSv1.2_2018 unless your viewers are using browsers or devices that don’t support TLSv1.2.

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.

Parameters:

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.

We recommend that you specify TLSv1.2_2018 unless your viewers are using browsers or devices that don’t support TLSv1.2.

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MinimumProtocolVersion, MinimumProtocolVersion

certificate

ViewerCertificate.Builder certificate(String certificate)

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

• ACMCertificateArn

• IAMCertificateId

• CloudFrontDefaultCertificate

Parameters:

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

• ACMCertificateArn

• IAMCertificateId

• CloudFrontDefaultCertificate

Returns:

Returns a reference to this object so that method calls can be chained together.

certificateSource

ViewerCertificate.Builder certificateSource(String certificateSource)

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

• ACMCertificateArn

• IAMCertificateId

• CloudFrontDefaultCertificate

Parameters:

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

• ACMCertificateArn

• IAMCertificateId

• CloudFrontDefaultCertificate

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CertificateSource, CertificateSource

certificateSource

ViewerCertificate.Builder certificateSource(CertificateSource certificateSource)

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

• ACMCertificateArn

• IAMCertificateId

• CloudFrontDefaultCertificate

Parameters:

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

• ACMCertificateArn

• IAMCertificateId

• CloudFrontDefaultCertificate

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CertificateSource, CertificateSource