RequestCertificateRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.acm.model.AcmRequest
    - - software.amazon.awssdk.services.acm.model.RequestCertificateRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<RequestCertificateRequest.Builder,RequestCertificateRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class RequestCertificateRequest
extends AcmRequest
implements ToCopyableBuilder<RequestCertificateRequest.Builder,RequestCertificateRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface RequestCertificateRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`RequestCertificateRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static RequestCertificateRequest.Builder`	`builder()`
`String`	`certificateAuthorityArn()` The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate.
`String`	`domainName()` Fully qualified domain name (FQDN), such as www.example.com, that you want to secure with an ACM certificate.
`List<DomainValidationOption>`	`domainValidationOptions()` The domain name that you want ACM to use to send you emails so that you can validate domain ownership.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`String`	`idempotencyToken()` Customer chosen string that can be used to distinguish between calls to `RequestCertificate`.
`CertificateOptions`	`options()` Currently, you can use this parameter to specify whether to add the certificate to a certificate transparency log.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RequestCertificateRequest.Builder>`	`serializableBuilderClass()`
`List<String>`	`subjectAlternativeNames()` Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate.
`RequestCertificateRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`ValidationMethod`	`validationMethod()` The method you want to use if you are requesting a public certificate to validate that you own or control domain.
`String`	`validationMethodAsString()` The method you want to use if you are requesting a public certificate to validate that you own or control domain.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - domainName
```
public String domainName()
```
    Fully qualified domain name (FQDN), such as www.example.com, that you want to secure with an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com, site.example.com, and images.example.com.
    
    The first domain name you enter cannot exceed 63 octets, including periods. Each subsequent Subject Alternative Name (SAN), however, can be up to 253 octets in length.
    
    Returns:
    
    Fully qualified domain name (FQDN), such as www.example.com, that you want to secure with an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com, site.example.com, and images.example.com.
    
    The first domain name you enter cannot exceed 63 octets, including periods. Each subsequent Subject Alternative Name (SAN), however, can be up to 253 octets in length.
  - validationMethod
```
public ValidationMethod validationMethod()
```
    The method you want to use if you are requesting a public certificate to validate that you own or control domain. You can validate with DNS or validate with email. We recommend that you use DNS validation.
    
    If the service returns an enum value that is not available in the current SDK version, validationMethod will return ValidationMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from validationMethodAsString().
    
    Returns:
    
    The method you want to use if you are requesting a public certificate to validate that you own or control domain. You can validate with DNS or validate with email. We recommend that you use DNS validation.
    
    See Also:
    
    ValidationMethod
  - validationMethodAsString
```
public String validationMethodAsString()
```
    The method you want to use if you are requesting a public certificate to validate that you own or control domain. You can validate with DNS or validate with email. We recommend that you use DNS validation.
    
    If the service returns an enum value that is not available in the current SDK version, validationMethod will return ValidationMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from validationMethodAsString().
    
    Returns:
    
    The method you want to use if you are requesting a public certificate to validate that you own or control domain. You can validate with DNS or validate with email. We recommend that you use DNS validation.
    
    See Also:
    
    ValidationMethod
  - subjectAlternativeNames
```
public List<String> subjectAlternativeNames()
```
    Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, add the name www.example.net to a certificate for which the DomainName field is www.example.com if users can reach your site by using either name. The maximum number of domain names that you can add to an ACM certificate is 100. However, the initial limit is 10 domain names. If you need more than 10 names, you must request a limit increase. For more information, see Limits.
    
    The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples:
    - (63 octets).(63 octets).(63 octets).(61 octets) is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets.
    - (64 octets).(63 octets).(63 octets).(61 octets) is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets.
    - (63 octets).(63 octets).(63 octets).(62 octets) is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    Returns:
    Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, add the name www.example.net to a certificate for which the DomainName field is www.example.com if users can reach your site by using either name. The maximum number of domain names that you can add to an ACM certificate is 100. However, the initial limit is 10 domain names. If you need more than 10 names, you must request a limit increase. For more information, see Limits.
    
    The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples:
    
    (63 octets).(63 octets).(63 octets).(61 octets) is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets.
    
    (64 octets).(63 octets).(63 octets).(61 octets) is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets.
    
    (63 octets).(63 octets).(63 octets).(62 octets) is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.
  - idempotencyToken
```
public String idempotencyToken()
```
    Customer chosen string that can be used to distinguish between calls to RequestCertificate. Idempotency tokens time out after one hour. Therefore, if you call RequestCertificate multiple times with the same idempotency token within one hour, ACM recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, ACM recognizes that you are requesting multiple certificates.
    
    Returns:
    
    Customer chosen string that can be used to distinguish between calls to RequestCertificate. Idempotency tokens time out after one hour. Therefore, if you call RequestCertificate multiple times with the same idempotency token within one hour, ACM recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, ACM recognizes that you are requesting multiple certificates.
  - domainValidationOptions
```
public List<DomainValidationOption> domainValidationOptions()
```
    The domain name that you want ACM to use to send you emails so that you can validate domain ownership.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The domain name that you want ACM to use to send you emails so that you can validate domain ownership.
  - options
```
public CertificateOptions options()
```
    Currently, you can use this parameter to specify whether to add the certificate to a certificate transparency log. Certificate transparency makes it possible to detect SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have not been logged typically produce an error message in a browser. For more information, see Opting Out of Certificate Transparency Logging.
    
    Returns:
    
    Currently, you can use this parameter to specify whether to add the certificate to a certificate transparency log. Certificate transparency makes it possible to detect SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have not been logged typically produce an error message in a browser. For more information, see Opting Out of Certificate Transparency Logging.
  - certificateAuthorityArn
```
public String certificateAuthorityArn()
```
    The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate. If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate. For more information about private CAs, see the AWS Certificate Manager Private Certificate Authority (PCA) user guide. The ARN must have the following form:
    
    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
    
    Returns:
    
    The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate. If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate. For more information about private CAs, see the AWS Certificate Manager Private Certificate Authority (PCA) user guide. The ARN must have the following form:
    
    arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
  - toBuilder
```
public RequestCertificateRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RequestCertificateRequest.Builder,RequestCertificateRequest>
    
    Specified by:
    
    toBuilder in class AcmRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static RequestCertificateRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RequestCertificateRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class RequestCertificateRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

domainName

validationMethod

validationMethodAsString

subjectAlternativeNames

idempotencyToken

domainValidationOptions

options

certificateAuthorityArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields