CertificateAuthority (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.acmpca.model.CertificateAuthority

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CertificateAuthority
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains information about your private certificate authority (CA). Your private CA can issue and revoke X.509 digital certificates. Digital certificates verify that the entity named in the certificate Subject field owns or controls the public key contained in the Subject Public Key Info field. Call the CreateCertificateAuthority action to create your private CA. You must then call the GetCertificateAuthorityCertificate action to retrieve a private CA certificate signing request (CSR). Sign the CSR with your ACM Private CA-hosted or on-premises root or subordinate CA certificate. Call the ImportCertificateAuthorityCertificate action to import the signed certificate into AWS Certificate Manager (ACM).

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CertificateAuthority()

Constructors
Constructor and Description
`CertificateAuthority()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CertificateAuthority`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` Amazon Resource Name (ARN) for your private certificate authority (CA).
`CertificateAuthorityConfiguration`	`getCertificateAuthorityConfiguration()` Your private CA configuration.
`Date`	`getCreatedAt()` Date and time at which your private CA was created.
`String`	`getFailureReason()` Reason the request to create your private CA failed.
`String`	`getKeyStorageSecurityStandard()` Defines a cryptographic key management compliance standard used for handling CA keys.
`Date`	`getLastStateChangeAt()` Date and time at which your private CA was last updated.
`Date`	`getNotAfter()` Date and time after which your private CA certificate is not valid.
`Date`	`getNotBefore()` Date and time before which your private CA certificate is not valid.
`String`	`getOwnerAccount()` The AWS account ID that owns the certificate authority.
`Date`	`getRestorableUntil()` The period during which a deleted CA can be restored.
`RevocationConfiguration`	`getRevocationConfiguration()` Information about the certificate revocation list (CRL) created and maintained by your private CA.
`String`	`getSerial()` Serial number of your private CA.
`String`	`getStatus()` Status of your private CA.
`String`	`getType()` Type of your private CA.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` Amazon Resource Name (ARN) for your private certificate authority (CA).
`void`	`setCertificateAuthorityConfiguration(CertificateAuthorityConfiguration certificateAuthorityConfiguration)` Your private CA configuration.
`void`	`setCreatedAt(Date createdAt)` Date and time at which your private CA was created.
`void`	`setFailureReason(String failureReason)` Reason the request to create your private CA failed.
`void`	`setKeyStorageSecurityStandard(String keyStorageSecurityStandard)` Defines a cryptographic key management compliance standard used for handling CA keys.
`void`	`setLastStateChangeAt(Date lastStateChangeAt)` Date and time at which your private CA was last updated.
`void`	`setNotAfter(Date notAfter)` Date and time after which your private CA certificate is not valid.
`void`	`setNotBefore(Date notBefore)` Date and time before which your private CA certificate is not valid.
`void`	`setOwnerAccount(String ownerAccount)` The AWS account ID that owns the certificate authority.
`void`	`setRestorableUntil(Date restorableUntil)` The period during which a deleted CA can be restored.
`void`	`setRevocationConfiguration(RevocationConfiguration revocationConfiguration)` Information about the certificate revocation list (CRL) created and maintained by your private CA.
`void`	`setSerial(String serial)` Serial number of your private CA.
`void`	`setStatus(String status)` Status of your private CA.
`void`	`setType(String type)` Type of your private CA.
`String`	`toString()` Returns a string representation of this object.
`CertificateAuthority`	`withArn(String arn)` Amazon Resource Name (ARN) for your private certificate authority (CA).
`CertificateAuthority`	`withCertificateAuthorityConfiguration(CertificateAuthorityConfiguration certificateAuthorityConfiguration)` Your private CA configuration.
`CertificateAuthority`	`withCreatedAt(Date createdAt)` Date and time at which your private CA was created.
`CertificateAuthority`	`withFailureReason(FailureReason failureReason)` Reason the request to create your private CA failed.
`CertificateAuthority`	`withFailureReason(String failureReason)` Reason the request to create your private CA failed.
`CertificateAuthority`	`withKeyStorageSecurityStandard(KeyStorageSecurityStandard keyStorageSecurityStandard)` Defines a cryptographic key management compliance standard used for handling CA keys.
`CertificateAuthority`	`withKeyStorageSecurityStandard(String keyStorageSecurityStandard)` Defines a cryptographic key management compliance standard used for handling CA keys.
`CertificateAuthority`	`withLastStateChangeAt(Date lastStateChangeAt)` Date and time at which your private CA was last updated.
`CertificateAuthority`	`withNotAfter(Date notAfter)` Date and time after which your private CA certificate is not valid.
`CertificateAuthority`	`withNotBefore(Date notBefore)` Date and time before which your private CA certificate is not valid.
`CertificateAuthority`	`withOwnerAccount(String ownerAccount)` The AWS account ID that owns the certificate authority.
`CertificateAuthority`	`withRestorableUntil(Date restorableUntil)` The period during which a deleted CA can be restored.
`CertificateAuthority`	`withRevocationConfiguration(RevocationConfiguration revocationConfiguration)` Information about the certificate revocation list (CRL) created and maintained by your private CA.
`CertificateAuthority`	`withSerial(String serial)` Serial number of your private CA.
`CertificateAuthority`	`withStatus(CertificateAuthorityStatus status)` Status of your private CA.
`CertificateAuthority`	`withStatus(String status)` Status of your private CA.
`CertificateAuthority`	`withType(CertificateAuthorityType type)` Type of your private CA.
`CertificateAuthority`	`withType(String type)` Type of your private CA.

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

- Constructor Detail
  - CertificateAuthority
```
public CertificateAuthority()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    Amazon Resource Name (ARN) for your private certificate authority (CA). The format is 12345678-1234-1234-1234-123456789012 .
    
    Parameters:
    
    arn - Amazon Resource Name (ARN) for your private certificate authority (CA). The format is 12345678-1234-1234-1234-123456789012 .
  - getArn
```
public String getArn()
```
    Amazon Resource Name (ARN) for your private certificate authority (CA). The format is 12345678-1234-1234-1234-123456789012 .
    
    Returns:
    
    Amazon Resource Name (ARN) for your private certificate authority (CA). The format is 12345678-1234-1234-1234-123456789012 .
  - withArn
```
public CertificateAuthority withArn(String arn)
```
    Amazon Resource Name (ARN) for your private certificate authority (CA). The format is 12345678-1234-1234-1234-123456789012 .
    
    Parameters:
    
    arn - Amazon Resource Name (ARN) for your private certificate authority (CA). The format is 12345678-1234-1234-1234-123456789012 .
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOwnerAccount
```
public void setOwnerAccount(String ownerAccount)
```
    The AWS account ID that owns the certificate authority.
    
    Parameters:
    
    ownerAccount - The AWS account ID that owns the certificate authority.
  - getOwnerAccount
```
public String getOwnerAccount()
```
    The AWS account ID that owns the certificate authority.
    
    Returns:
    
    The AWS account ID that owns the certificate authority.
  - withOwnerAccount
```
public CertificateAuthority withOwnerAccount(String ownerAccount)
```
    The AWS account ID that owns the certificate authority.
    
    Parameters:
    
    ownerAccount - The AWS account ID that owns the certificate authority.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    Date and time at which your private CA was created.
    
    Parameters:
    
    createdAt - Date and time at which your private CA was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    Date and time at which your private CA was created.
    
    Returns:
    
    Date and time at which your private CA was created.
  - withCreatedAt
```
public CertificateAuthority withCreatedAt(Date createdAt)
```
    Date and time at which your private CA was created.
    
    Parameters:
    
    createdAt - Date and time at which your private CA was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastStateChangeAt
```
public void setLastStateChangeAt(Date lastStateChangeAt)
```
    Date and time at which your private CA was last updated.
    
    Parameters:
    
    lastStateChangeAt - Date and time at which your private CA was last updated.
  - getLastStateChangeAt
```
public Date getLastStateChangeAt()
```
    Date and time at which your private CA was last updated.
    
    Returns:
    
    Date and time at which your private CA was last updated.
  - withLastStateChangeAt
```
public CertificateAuthority withLastStateChangeAt(Date lastStateChangeAt)
```
    Date and time at which your private CA was last updated.
    
    Parameters:
    
    lastStateChangeAt - Date and time at which your private CA was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    Type of your private CA.
    
    Parameters:
    
    type - Type of your private CA.
    
    See Also:
    
    CertificateAuthorityType
  - getType
```
public String getType()
```
    Type of your private CA.
    
    Returns:
    
    Type of your private CA.
    
    See Also:
    
    CertificateAuthorityType
  - withType
```
public CertificateAuthority withType(String type)
```
    Type of your private CA.
    
    Parameters:
    
    type - Type of your private CA.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CertificateAuthorityType
  - withType
```
public CertificateAuthority withType(CertificateAuthorityType type)
```
    Type of your private CA.
    
    Parameters:
    
    type - Type of your private CA.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CertificateAuthorityType
  - setSerial
```
public void setSerial(String serial)
```
    Serial number of your private CA.
    
    Parameters:
    
    serial - Serial number of your private CA.
  - getSerial
```
public String getSerial()
```
    Serial number of your private CA.
    
    Returns:
    
    Serial number of your private CA.
  - withSerial
```
public CertificateAuthority withSerial(String serial)
```
    Serial number of your private CA.
    
    Parameters:
    
    serial - Serial number of your private CA.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    Status of your private CA.
    
    Parameters:
    
    status - Status of your private CA.
    
    See Also:
    
    CertificateAuthorityStatus
  - getStatus
```
public String getStatus()
```
    Status of your private CA.
    
    Returns:
    
    Status of your private CA.
    
    See Also:
    
    CertificateAuthorityStatus
  - withStatus
```
public CertificateAuthority withStatus(String status)
```
    Status of your private CA.
    
    Parameters:
    
    status - Status of your private CA.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CertificateAuthorityStatus
  - withStatus
```
public CertificateAuthority withStatus(CertificateAuthorityStatus status)
```
    Status of your private CA.
    
    Parameters:
    
    status - Status of your private CA.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CertificateAuthorityStatus
  - setNotBefore
```
public void setNotBefore(Date notBefore)
```
    Date and time before which your private CA certificate is not valid.
    
    Parameters:
    
    notBefore - Date and time before which your private CA certificate is not valid.
  - getNotBefore
```
public Date getNotBefore()
```
    Date and time before which your private CA certificate is not valid.
    
    Returns:
    
    Date and time before which your private CA certificate is not valid.
  - withNotBefore
```
public CertificateAuthority withNotBefore(Date notBefore)
```
    Date and time before which your private CA certificate is not valid.
    
    Parameters:
    
    notBefore - Date and time before which your private CA certificate is not valid.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNotAfter
```
public void setNotAfter(Date notAfter)
```
    Date and time after which your private CA certificate is not valid.
    
    Parameters:
    
    notAfter - Date and time after which your private CA certificate is not valid.
  - getNotAfter
```
public Date getNotAfter()
```
    Date and time after which your private CA certificate is not valid.
    
    Returns:
    
    Date and time after which your private CA certificate is not valid.
  - withNotAfter
```
public CertificateAuthority withNotAfter(Date notAfter)
```
    Date and time after which your private CA certificate is not valid.
    
    Parameters:
    
    notAfter - Date and time after which your private CA certificate is not valid.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFailureReason
```
public void setFailureReason(String failureReason)
```
    Reason the request to create your private CA failed.
    
    Parameters:
    
    failureReason - Reason the request to create your private CA failed.
    
    See Also:
    
    FailureReason
  - getFailureReason
```
public String getFailureReason()
```
    Reason the request to create your private CA failed.
    
    Returns:
    
    Reason the request to create your private CA failed.
    
    See Also:
    
    FailureReason
  - withFailureReason
```
public CertificateAuthority withFailureReason(String failureReason)
```
    Reason the request to create your private CA failed.
    
    Parameters:
    
    failureReason - Reason the request to create your private CA failed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FailureReason
  - withFailureReason
```
public CertificateAuthority withFailureReason(FailureReason failureReason)
```
    Reason the request to create your private CA failed.
    
    Parameters:
    
    failureReason - Reason the request to create your private CA failed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    FailureReason
  - setCertificateAuthorityConfiguration
```
public void setCertificateAuthorityConfiguration(CertificateAuthorityConfiguration certificateAuthorityConfiguration)
```
    Your private CA configuration.
    
    Parameters:
    
    certificateAuthorityConfiguration - Your private CA configuration.
  - getCertificateAuthorityConfiguration
```
public CertificateAuthorityConfiguration getCertificateAuthorityConfiguration()
```
    Your private CA configuration.
    
    Returns:
    
    Your private CA configuration.
  - withCertificateAuthorityConfiguration
```
public CertificateAuthority withCertificateAuthorityConfiguration(CertificateAuthorityConfiguration certificateAuthorityConfiguration)
```
    Your private CA configuration.
    
    Parameters:
    
    certificateAuthorityConfiguration - Your private CA configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRevocationConfiguration
```
public void setRevocationConfiguration(RevocationConfiguration revocationConfiguration)
```
    Information about the certificate revocation list (CRL) created and maintained by your private CA.
    
    Parameters:
    
    revocationConfiguration - Information about the certificate revocation list (CRL) created and maintained by your private CA.
  - getRevocationConfiguration
```
public RevocationConfiguration getRevocationConfiguration()
```
    Information about the certificate revocation list (CRL) created and maintained by your private CA.
    
    Returns:
    
    Information about the certificate revocation list (CRL) created and maintained by your private CA.
  - withRevocationConfiguration
```
public CertificateAuthority withRevocationConfiguration(RevocationConfiguration revocationConfiguration)
```
    Information about the certificate revocation list (CRL) created and maintained by your private CA.
    
    Parameters:
    
    revocationConfiguration - Information about the certificate revocation list (CRL) created and maintained by your private CA.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRestorableUntil
```
public void setRestorableUntil(Date restorableUntil)
```
    The period during which a deleted CA can be restored. For more information, see the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthorityRequest action.
    
    Parameters:
    
    restorableUntil - The period during which a deleted CA can be restored. For more information, see the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthorityRequest action.
  - getRestorableUntil
```
public Date getRestorableUntil()
```
    The period during which a deleted CA can be restored. For more information, see the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthorityRequest action.
    
    Returns:
    
    The period during which a deleted CA can be restored. For more information, see the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthorityRequest action.
  - withRestorableUntil
```
public CertificateAuthority withRestorableUntil(Date restorableUntil)
```
    The period during which a deleted CA can be restored. For more information, see the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthorityRequest action.
    
    Parameters:
    
    restorableUntil - The period during which a deleted CA can be restored. For more information, see the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthorityRequest action.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKeyStorageSecurityStandard
```
public void setKeyStorageSecurityStandard(String keyStorageSecurityStandard)
```
    Defines a cryptographic key management compliance standard used for handling CA keys.
    
    Default: FIPS_140_2_LEVEL_3_OR_HIGHER
    
    Note: AWS Region ap-northeast-3 supports only FIPS_140_2_LEVEL_2_OR_HIGHER. You must explicitly specify this parameter and value when creating a CA in that Region. Specifying a different value (or no value) results in an InvalidArgsException with the message "A certificate authority cannot be created in this region with the specified security standard."
    
    Parameters:
    
    keyStorageSecurityStandard - Defines a cryptographic key management compliance standard used for handling CA keys.
    
    Default: FIPS_140_2_LEVEL_3_OR_HIGHER
    
    Note: AWS Region ap-northeast-3 supports only FIPS_140_2_LEVEL_2_OR_HIGHER. You must explicitly specify this parameter and value when creating a CA in that Region. Specifying a different value (or no value) results in an InvalidArgsException with the message "A certificate authority cannot be created in this region with the specified security standard."
    
    See Also:
    
    KeyStorageSecurityStandard
  - getKeyStorageSecurityStandard
```
public String getKeyStorageSecurityStandard()
```
    Defines a cryptographic key management compliance standard used for handling CA keys.
    
    Default: FIPS_140_2_LEVEL_3_OR_HIGHER
    
    Note: AWS Region ap-northeast-3 supports only FIPS_140_2_LEVEL_2_OR_HIGHER. You must explicitly specify this parameter and value when creating a CA in that Region. Specifying a different value (or no value) results in an InvalidArgsException with the message "A certificate authority cannot be created in this region with the specified security standard."
    
    Returns:
    
    Defines a cryptographic key management compliance standard used for handling CA keys.
    
    Default: FIPS_140_2_LEVEL_3_OR_HIGHER
    
    Note: AWS Region ap-northeast-3 supports only FIPS_140_2_LEVEL_2_OR_HIGHER. You must explicitly specify this parameter and value when creating a CA in that Region. Specifying a different value (or no value) results in an InvalidArgsException with the message "A certificate authority cannot be created in this region with the specified security standard."
    
    See Also:
    
    KeyStorageSecurityStandard
  - withKeyStorageSecurityStandard
```
public CertificateAuthority withKeyStorageSecurityStandard(String keyStorageSecurityStandard)
```
    Defines a cryptographic key management compliance standard used for handling CA keys.
    
    Default: FIPS_140_2_LEVEL_3_OR_HIGHER
    
    Note: AWS Region ap-northeast-3 supports only FIPS_140_2_LEVEL_2_OR_HIGHER. You must explicitly specify this parameter and value when creating a CA in that Region. Specifying a different value (or no value) results in an InvalidArgsException with the message "A certificate authority cannot be created in this region with the specified security standard."
    
    Parameters:
    
    keyStorageSecurityStandard - Defines a cryptographic key management compliance standard used for handling CA keys.
    
    Default: FIPS_140_2_LEVEL_3_OR_HIGHER
    
    Note: AWS Region ap-northeast-3 supports only FIPS_140_2_LEVEL_2_OR_HIGHER. You must explicitly specify this parameter and value when creating a CA in that Region. Specifying a different value (or no value) results in an InvalidArgsException with the message "A certificate authority cannot be created in this region with the specified security standard."
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KeyStorageSecurityStandard
  - withKeyStorageSecurityStandard
```
public CertificateAuthority withKeyStorageSecurityStandard(KeyStorageSecurityStandard keyStorageSecurityStandard)
```
    Defines a cryptographic key management compliance standard used for handling CA keys.
    
    Default: FIPS_140_2_LEVEL_3_OR_HIGHER
    
    Note: AWS Region ap-northeast-3 supports only FIPS_140_2_LEVEL_2_OR_HIGHER. You must explicitly specify this parameter and value when creating a CA in that Region. Specifying a different value (or no value) results in an InvalidArgsException with the message "A certificate authority cannot be created in this region with the specified security standard."
    
    Parameters:
    
    keyStorageSecurityStandard - Defines a cryptographic key management compliance standard used for handling CA keys.
    
    Default: FIPS_140_2_LEVEL_3_OR_HIGHER
    
    Note: AWS Region ap-northeast-3 supports only FIPS_140_2_LEVEL_2_OR_HIGHER. You must explicitly specify this parameter and value when creating a CA in that Region. Specifying a different value (or no value) results in an InvalidArgsException with the message "A certificate authority cannot be created in this region with the specified security standard."
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KeyStorageSecurityStandard
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CertificateAuthority clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class CertificateAuthority

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CertificateAuthority

Method Detail

setArn

getArn

withArn

setOwnerAccount

getOwnerAccount

withOwnerAccount

setCreatedAt

getCreatedAt

withCreatedAt

setLastStateChangeAt

getLastStateChangeAt

withLastStateChangeAt

setType

getType

withType

withType

setSerial

getSerial

withSerial

setStatus

getStatus

withStatus

withStatus

setNotBefore

getNotBefore

withNotBefore

setNotAfter

getNotAfter

withNotAfter

setFailureReason

getFailureReason

withFailureReason

withFailureReason

setCertificateAuthorityConfiguration

getCertificateAuthorityConfiguration

withCertificateAuthorityConfiguration

setRevocationConfiguration

getRevocationConfiguration

withRevocationConfiguration

setRestorableUntil

getRestorableUntil

withRestorableUntil

setKeyStorageSecurityStandard

getKeyStorageSecurityStandard

withKeyStorageSecurityStandard

withKeyStorageSecurityStandard

toString

equals

hashCode

clone

marshall