Package 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 Details

    • 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 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.

      Parameters:
      iamCertificateId - If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in 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.

      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 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.

      Parameters:
      acmCertificateArn - If the distribution uses Aliases (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in 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.

      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 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.

      • static-ip - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the Amazon Web Services Support Center.

      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 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.

      • static-ip - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the Amazon Web Services Support Center.

      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

      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 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.

      • static-ip - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the Amazon Web Services Support Center.

      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 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.

      • static-ip - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the Amazon Web Services Support Center.

      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:

    • 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.

      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.

      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

      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.

      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.

      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:

    • certificate

      @Deprecated ViewerCertificate.Builder certificate(String certificate)
      Deprecated.

      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

      @Deprecated ViewerCertificate.Builder certificateSource(String certificateSource)
      Deprecated.

      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

      @Deprecated ViewerCertificate.Builder certificateSource(CertificateSource certificateSource)
      Deprecated.

      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: