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 you want viewers to use HTTPS to request your objects and you're using an alternate domain name, you must choose the type of certificate that you want to use.
ViewerCertificate.Builder	certificate(String certificate) This field is no longer used.
ViewerCertificate.Builder	certificateSource(CertificateSource certificateSource) This field is no longer used.
ViewerCertificate.Builder	certificateSource(String certificateSource) This field is no longer used.
ViewerCertificate.Builder	cloudFrontDefaultCertificate(Boolean cloudFrontDefaultCertificate) If you're using the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net, specify the following value:
ViewerCertificate.Builder	iamCertificateId(String iamCertificateId) If you want viewers to use HTTPS to request your objects and you're using an alternate domain name, you must choose the type of certificate that you want to use.
ViewerCertificate.Builder	minimumProtocolVersion(MinimumProtocolVersion minimumProtocolVersion) Specify the security policy that you want CloudFront to use for HTTPS connections.
ViewerCertificate.Builder	minimumProtocolVersion(String minimumProtocolVersion) Specify the security policy that you want CloudFront to use for HTTPS connections.
ViewerCertificate.Builder	sslSupportMethod(SSLSupportMethod sslSupportMethod) If you specify a value for ACMCertificateArn or for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for browsers and clients released after 2010 or one that works for all clients.
ViewerCertificate.Builder	sslSupportMethod(String sslSupportMethod) If you specify a value for ACMCertificateArn or for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for browsers and clients released after 2010 or one that works for all clients.

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 you're using the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net, specify the following value:

• <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>

Parameters:

cloudFrontDefaultCertificate - If you're using the CloudFront domain name for your distribution, such as d111111abcdef8.cloudfront.net, specify the following value:

• <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>

Returns:

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

iamCertificateId

ViewerCertificate.Builder iamCertificateId(String iamCertificateId)

If you want viewers to use HTTPS to request your objects and you're using an alternate domain name, you must choose the type of certificate that you want to use. Specify the following value if you purchased your certificate from a third-party certificate authority:

• <IAMCertificateId>IAM certificate ID<IAMCertificateId> where IAM certificate ID is the ID that IAM returned when you added the certificate to the IAM certificate store.

If you specify IAMCertificateId, you must also specify a value for SSLSupportMethod .

Parameters:

iamCertificateId - If you want viewers to use HTTPS to request your objects and you're using an alternate domain name, you must choose the type of certificate that you want to use. Specify the following value if you purchased your certificate from a third-party certificate authority:

• <IAMCertificateId>IAM certificate ID<IAMCertificateId> where IAM certificate ID is the ID that IAM returned when you added the certificate to the IAM certificate store.

If you specify IAMCertificateId, you must also specify a value for SSLSupportMethod.

Returns:

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

acmCertificateArn

ViewerCertificate.Builder acmCertificateArn(String acmCertificateArn)

If you want viewers to use HTTPS to request your objects and you're using an alternate domain name, you must choose the type of certificate that you want to use. Specify the following value if ACM provided your certificate:

• <ACMCertificateArn>ARN for ACM SSL/TLS certificate<ACMCertificateArn> where ARN for ACM SSL/TLS certificate is the ARN for the ACM SSL/TLS certificate that you want to use for this distribution.

If you specify ACMCertificateArn, you must also specify a value for SSLSupportMethod.

Parameters:

acmCertificateArn - If you want viewers to use HTTPS to request your objects and you're using an alternate domain name, you must choose the type of certificate that you want to use. Specify the following value if ACM provided your certificate:

• <ACMCertificateArn>ARN for ACM SSL/TLS certificate<ACMCertificateArn> where ARN for ACM SSL/TLS certificate is the ARN for the ACM SSL/TLS certificate that you want to use for this distribution.

If you specify ACMCertificateArn, you must also specify a value for SSLSupportMethod.

Returns:

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

sslSupportMethod

ViewerCertificate.Builder sslSupportMethod(String sslSupportMethod)

If you specify a value for ACMCertificateArn or for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for browsers and clients released after 2010 or one that works for all clients.

• sni-only: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but there are a few that don't. For a current list of the browsers that support SNI, see the Wikipedia entry Server Name Indication. To learn about options to explore if you have users with browsers that don't include SNI support, see Choosing How CloudFront Serves HTTPS Requests in the Amazon CloudFront Developer Guide.

• vip: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, there are additional monthly charges. For details, including specific pricing information, see Custom SSL options for Amazon CloudFront on the AWS marketing site.

Don't specify a value for SSLSupportMethod if you specified <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>.

For more information, see Choosing How CloudFront Serves HTTPS Requests in the Amazon CloudFront Developer Guide.

Parameters:

sslSupportMethod - If you specify a value for ACMCertificateArn or for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for browsers and clients released after 2010 or one that works for all clients.

• sni-only: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but there are a few that don't. For a current list of the browsers that support SNI, see the Wikipedia entry Server Name Indication. To learn about options to explore if you have users with browsers that don't include SNI support, see Choosing How CloudFront Serves HTTPS Requests in the Amazon CloudFront Developer Guide.

• vip: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, there are additional monthly charges. For details, including specific pricing information, see Custom SSL options for Amazon CloudFront on the AWS marketing site.

Don't specify a value for SSLSupportMethod if you specified <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>.

For more information, see Choosing How CloudFront Serves HTTPS Requests in the Amazon CloudFront Developer Guide.

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 you specify a value for ACMCertificateArn or for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for browsers and clients released after 2010 or one that works for all clients.

• sni-only: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but there are a few that don't. For a current list of the browsers that support SNI, see the Wikipedia entry Server Name Indication. To learn about options to explore if you have users with browsers that don't include SNI support, see Choosing How CloudFront Serves HTTPS Requests in the Amazon CloudFront Developer Guide.

• vip: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, there are additional monthly charges. For details, including specific pricing information, see Custom SSL options for Amazon CloudFront on the AWS marketing site.

Don't specify a value for SSLSupportMethod if you specified <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>.

For more information, see Choosing How CloudFront Serves HTTPS Requests in the Amazon CloudFront Developer Guide.

Parameters:

sslSupportMethod - If you specify a value for ACMCertificateArn or for IAMCertificateId, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for browsers and clients released after 2010 or one that works for all clients.

• sni-only: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but there are a few that don't. For a current list of the browsers that support SNI, see the Wikipedia entry Server Name Indication. To learn about options to explore if you have users with browsers that don't include SNI support, see Choosing How CloudFront Serves HTTPS Requests in the Amazon CloudFront Developer Guide.

• vip: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, there are additional monthly charges. For details, including specific pricing information, see Custom SSL options for Amazon CloudFront on the AWS marketing site.

Don't specify a value for SSLSupportMethod if you specified <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>.

For more information, see Choosing How CloudFront Serves HTTPS Requests in the Amazon CloudFront Developer Guide.

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)

Specify the security policy that you want CloudFront to use for HTTPS connections. A security policy determines two settings:

• The minimum SSL/TLS protocol that CloudFront uses to communicate with viewers

• The cipher that CloudFront uses to encrypt the content that it returns to viewers

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

We recommend that you specify TLSv1.1_2016 unless your users are using browsers or devices that do not support TLSv1.1 or later.

When both of the following are true, you must specify TLSv1 or later for the security policy:

• You're using a custom certificate: you specified a value for ACMCertificateArn or for IAMCertificateId

• You're using SNI: you specified sni-only for SSLSupportMethod

If you specify true for CloudFrontDefaultCertificate, CloudFront automatically sets the security policy to TLSv1 regardless of the value that you specify for MinimumProtocolVersion.

For information about the relationship between the security policy that you choose and the protocols and ciphers that CloudFront uses to communicate with viewers, see Supported SSL/TLS Protocols and Ciphers for Communication Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

Parameters:

minimumProtocolVersion - Specify the security policy that you want CloudFront to use for HTTPS connections. A security policy determines two settings:

• The minimum SSL/TLS protocol that CloudFront uses to communicate with viewers

• The cipher that CloudFront uses to encrypt the content that it returns to viewers

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

We recommend that you specify TLSv1.1_2016 unless your users are using browsers or devices that do not support TLSv1.1 or later.

When both of the following are true, you must specify TLSv1 or later for the security policy:

• You're using a custom certificate: you specified a value for ACMCertificateArn or for IAMCertificateId

• You're using SNI: you specified sni-only for SSLSupportMethod

If you specify true for CloudFrontDefaultCertificate, CloudFront automatically sets the security policy to TLSv1 regardless of the value that you specify for MinimumProtocolVersion.

For information about the relationship between the security policy that you choose and the protocols and ciphers that CloudFront uses to communicate with viewers, see Supported SSL/TLS Protocols and Ciphers for Communication Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

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)

Specify the security policy that you want CloudFront to use for HTTPS connections. A security policy determines two settings:

• The minimum SSL/TLS protocol that CloudFront uses to communicate with viewers

• The cipher that CloudFront uses to encrypt the content that it returns to viewers

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

We recommend that you specify TLSv1.1_2016 unless your users are using browsers or devices that do not support TLSv1.1 or later.

When both of the following are true, you must specify TLSv1 or later for the security policy:

• You're using a custom certificate: you specified a value for ACMCertificateArn or for IAMCertificateId

• You're using SNI: you specified sni-only for SSLSupportMethod

If you specify true for CloudFrontDefaultCertificate, CloudFront automatically sets the security policy to TLSv1 regardless of the value that you specify for MinimumProtocolVersion.

For information about the relationship between the security policy that you choose and the protocols and ciphers that CloudFront uses to communicate with viewers, see Supported SSL/TLS Protocols and Ciphers for Communication Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

Parameters:

minimumProtocolVersion - Specify the security policy that you want CloudFront to use for HTTPS connections. A security policy determines two settings:

• The minimum SSL/TLS protocol that CloudFront uses to communicate with viewers

• The cipher that CloudFront uses to encrypt the content that it returns to viewers

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

We recommend that you specify TLSv1.1_2016 unless your users are using browsers or devices that do not support TLSv1.1 or later.

When both of the following are true, you must specify TLSv1 or later for the security policy:

• You're using a custom certificate: you specified a value for ACMCertificateArn or for IAMCertificateId

• You're using SNI: you specified sni-only for SSLSupportMethod

If you specify true for CloudFrontDefaultCertificate, CloudFront automatically sets the security policy to TLSv1 regardless of the value that you specify for MinimumProtocolVersion.

For information about the relationship between the security policy that you choose and the protocols and ciphers that CloudFront uses to communicate with viewers, see Supported SSL/TLS Protocols and Ciphers for Communication Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

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 no longer used. Use one of the following fields instead:

• ACMCertificateArn

• IAMCertificateId

• CloudFrontDefaultCertificate

Parameters:

certificate - This field is no longer used. 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 no longer used. Use one of the following fields instead:

• ACMCertificateArn

• IAMCertificateId

• CloudFrontDefaultCertificate

Parameters:

certificateSource - This field is no longer used. 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 no longer used. Use one of the following fields instead:

• ACMCertificateArn

• IAMCertificateId

• CloudFrontDefaultCertificate

Parameters:

certificateSource - This field is no longer used. 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