@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateCertificateAuthorityRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateCertificateAuthorityRequest() |
Modifier and Type | Method and Description |
---|---|
CreateCertificateAuthorityRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
CertificateAuthorityConfiguration |
getCertificateAuthorityConfiguration()
Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate subject
information.
|
String |
getCertificateAuthorityType()
The type of the certificate authority.
|
String |
getIdempotencyToken()
Custom string that can be used to distinguish between calls to the CreateCertificateAuthority action.
|
String |
getKeyStorageSecurityStandard()
Specifies a cryptographic key management compliance standard used for handling CA keys.
|
RevocationConfiguration |
getRevocationConfiguration()
Contains information to enable Online Certificate Status Protocol (OCSP) support, to enable a certificate
revocation list (CRL), to enable both, or to enable neither.
|
List<Tag> |
getTags()
Key-value pairs that will be attached to the new private CA.
|
String |
getUsageMode()
Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or
short-lived certificates that may optionally omit revocation because they expire quickly.
|
int |
hashCode() |
void |
setCertificateAuthorityConfiguration(CertificateAuthorityConfiguration certificateAuthorityConfiguration)
Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate subject
information.
|
void |
setCertificateAuthorityType(String certificateAuthorityType)
The type of the certificate authority.
|
void |
setIdempotencyToken(String idempotencyToken)
Custom string that can be used to distinguish between calls to the CreateCertificateAuthority action.
|
void |
setKeyStorageSecurityStandard(String keyStorageSecurityStandard)
Specifies a cryptographic key management compliance standard used for handling CA keys.
|
void |
setRevocationConfiguration(RevocationConfiguration revocationConfiguration)
Contains information to enable Online Certificate Status Protocol (OCSP) support, to enable a certificate
revocation list (CRL), to enable both, or to enable neither.
|
void |
setTags(Collection<Tag> tags)
Key-value pairs that will be attached to the new private CA.
|
void |
setUsageMode(String usageMode)
Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or
short-lived certificates that may optionally omit revocation because they expire quickly.
|
String |
toString()
Returns a string representation of this object.
|
CreateCertificateAuthorityRequest |
withCertificateAuthorityConfiguration(CertificateAuthorityConfiguration certificateAuthorityConfiguration)
Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate subject
information.
|
CreateCertificateAuthorityRequest |
withCertificateAuthorityType(CertificateAuthorityType certificateAuthorityType)
The type of the certificate authority.
|
CreateCertificateAuthorityRequest |
withCertificateAuthorityType(String certificateAuthorityType)
The type of the certificate authority.
|
CreateCertificateAuthorityRequest |
withIdempotencyToken(String idempotencyToken)
Custom string that can be used to distinguish between calls to the CreateCertificateAuthority action.
|
CreateCertificateAuthorityRequest |
withKeyStorageSecurityStandard(KeyStorageSecurityStandard keyStorageSecurityStandard)
Specifies a cryptographic key management compliance standard used for handling CA keys.
|
CreateCertificateAuthorityRequest |
withKeyStorageSecurityStandard(String keyStorageSecurityStandard)
Specifies a cryptographic key management compliance standard used for handling CA keys.
|
CreateCertificateAuthorityRequest |
withRevocationConfiguration(RevocationConfiguration revocationConfiguration)
Contains information to enable Online Certificate Status Protocol (OCSP) support, to enable a certificate
revocation list (CRL), to enable both, or to enable neither.
|
CreateCertificateAuthorityRequest |
withTags(Collection<Tag> tags)
Key-value pairs that will be attached to the new private CA.
|
CreateCertificateAuthorityRequest |
withTags(Tag... tags)
Key-value pairs that will be attached to the new private CA.
|
CreateCertificateAuthorityRequest |
withUsageMode(CertificateAuthorityUsageMode usageMode)
Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or
short-lived certificates that may optionally omit revocation because they expire quickly.
|
CreateCertificateAuthorityRequest |
withUsageMode(String usageMode)
Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or
short-lived certificates that may optionally omit revocation because they expire quickly.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setCertificateAuthorityConfiguration(CertificateAuthorityConfiguration certificateAuthorityConfiguration)
Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate subject information.
certificateAuthorityConfiguration
- Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate
subject information.public CertificateAuthorityConfiguration getCertificateAuthorityConfiguration()
Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate subject information.
public CreateCertificateAuthorityRequest withCertificateAuthorityConfiguration(CertificateAuthorityConfiguration certificateAuthorityConfiguration)
Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate subject information.
certificateAuthorityConfiguration
- Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate
subject information.public void setRevocationConfiguration(RevocationConfiguration revocationConfiguration)
Contains information to enable Online Certificate Status Protocol (OCSP) support, to enable a certificate revocation list (CRL), to enable both, or to enable neither. The default is for both certificate validation mechanisms to be disabled.
The following requirements apply to revocation configurations.
A configuration disabling CRLs or OCSP must contain only the Enabled=False
parameter, and will fail
if other parameters such as CustomCname
or ExpirationInDays
are included.
In a CRL configuration, the S3BucketName
parameter must conform to Amazon S3 bucket naming
rules.
A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.
In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as "http://" or "https://".
For more information, see the OcspConfiguration and CrlConfiguration types.
revocationConfiguration
- Contains information to enable Online Certificate Status Protocol (OCSP) support, to enable a certificate
revocation list (CRL), to enable both, or to enable neither. The default is for both certificate
validation mechanisms to be disabled. The following requirements apply to revocation configurations.
A configuration disabling CRLs or OCSP must contain only the Enabled=False
parameter, and
will fail if other parameters such as CustomCname
or ExpirationInDays
are
included.
In a CRL configuration, the S3BucketName
parameter must conform to Amazon S3 bucket
naming rules.
A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.
In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as "http://" or "https://".
For more information, see the OcspConfiguration and CrlConfiguration types.
public RevocationConfiguration getRevocationConfiguration()
Contains information to enable Online Certificate Status Protocol (OCSP) support, to enable a certificate revocation list (CRL), to enable both, or to enable neither. The default is for both certificate validation mechanisms to be disabled.
The following requirements apply to revocation configurations.
A configuration disabling CRLs or OCSP must contain only the Enabled=False
parameter, and will fail
if other parameters such as CustomCname
or ExpirationInDays
are included.
In a CRL configuration, the S3BucketName
parameter must conform to Amazon S3 bucket naming
rules.
A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.
In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as "http://" or "https://".
For more information, see the OcspConfiguration and CrlConfiguration types.
The following requirements apply to revocation configurations.
A configuration disabling CRLs or OCSP must contain only the Enabled=False
parameter, and
will fail if other parameters such as CustomCname
or ExpirationInDays
are
included.
In a CRL configuration, the S3BucketName
parameter must conform to Amazon S3 bucket
naming rules.
A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.
In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as "http://" or "https://".
For more information, see the OcspConfiguration and CrlConfiguration types.
public CreateCertificateAuthorityRequest withRevocationConfiguration(RevocationConfiguration revocationConfiguration)
Contains information to enable Online Certificate Status Protocol (OCSP) support, to enable a certificate revocation list (CRL), to enable both, or to enable neither. The default is for both certificate validation mechanisms to be disabled.
The following requirements apply to revocation configurations.
A configuration disabling CRLs or OCSP must contain only the Enabled=False
parameter, and will fail
if other parameters such as CustomCname
or ExpirationInDays
are included.
In a CRL configuration, the S3BucketName
parameter must conform to Amazon S3 bucket naming
rules.
A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.
In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as "http://" or "https://".
For more information, see the OcspConfiguration and CrlConfiguration types.
revocationConfiguration
- Contains information to enable Online Certificate Status Protocol (OCSP) support, to enable a certificate
revocation list (CRL), to enable both, or to enable neither. The default is for both certificate
validation mechanisms to be disabled. The following requirements apply to revocation configurations.
A configuration disabling CRLs or OCSP must contain only the Enabled=False
parameter, and
will fail if other parameters such as CustomCname
or ExpirationInDays
are
included.
In a CRL configuration, the S3BucketName
parameter must conform to Amazon S3 bucket
naming rules.
A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.
In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as "http://" or "https://".
For more information, see the OcspConfiguration and CrlConfiguration types.
public void setCertificateAuthorityType(String certificateAuthorityType)
The type of the certificate authority.
certificateAuthorityType
- The type of the certificate authority.CertificateAuthorityType
public String getCertificateAuthorityType()
The type of the certificate authority.
CertificateAuthorityType
public CreateCertificateAuthorityRequest withCertificateAuthorityType(String certificateAuthorityType)
The type of the certificate authority.
certificateAuthorityType
- The type of the certificate authority.CertificateAuthorityType
public CreateCertificateAuthorityRequest withCertificateAuthorityType(CertificateAuthorityType certificateAuthorityType)
The type of the certificate authority.
certificateAuthorityType
- The type of the certificate authority.CertificateAuthorityType
public void setIdempotencyToken(String idempotencyToken)
Custom string that can be used to distinguish between calls to the CreateCertificateAuthority action. Idempotency tokens for CreateCertificateAuthority time out after five minutes. Therefore, if you call CreateCertificateAuthority multiple times with the same idempotency token within five minutes, Amazon Web Services Private CA recognizes that you are requesting only certificate authority and will issue only one. If you change the idempotency token for each call, Amazon Web Services Private CA recognizes that you are requesting multiple certificate authorities.
idempotencyToken
- Custom string that can be used to distinguish between calls to the CreateCertificateAuthority
action. Idempotency tokens for CreateCertificateAuthority time out after five minutes. Therefore,
if you call CreateCertificateAuthority multiple times with the same idempotency token within five
minutes, Amazon Web Services Private CA recognizes that you are requesting only certificate authority and
will issue only one. If you change the idempotency token for each call, Amazon Web Services Private CA
recognizes that you are requesting multiple certificate authorities.public String getIdempotencyToken()
Custom string that can be used to distinguish between calls to the CreateCertificateAuthority action. Idempotency tokens for CreateCertificateAuthority time out after five minutes. Therefore, if you call CreateCertificateAuthority multiple times with the same idempotency token within five minutes, Amazon Web Services Private CA recognizes that you are requesting only certificate authority and will issue only one. If you change the idempotency token for each call, Amazon Web Services Private CA recognizes that you are requesting multiple certificate authorities.
public CreateCertificateAuthorityRequest withIdempotencyToken(String idempotencyToken)
Custom string that can be used to distinguish between calls to the CreateCertificateAuthority action. Idempotency tokens for CreateCertificateAuthority time out after five minutes. Therefore, if you call CreateCertificateAuthority multiple times with the same idempotency token within five minutes, Amazon Web Services Private CA recognizes that you are requesting only certificate authority and will issue only one. If you change the idempotency token for each call, Amazon Web Services Private CA recognizes that you are requesting multiple certificate authorities.
idempotencyToken
- Custom string that can be used to distinguish between calls to the CreateCertificateAuthority
action. Idempotency tokens for CreateCertificateAuthority time out after five minutes. Therefore,
if you call CreateCertificateAuthority multiple times with the same idempotency token within five
minutes, Amazon Web Services Private CA recognizes that you are requesting only certificate authority and
will issue only one. If you change the idempotency token for each call, Amazon Web Services Private CA
recognizes that you are requesting multiple certificate authorities.public void setKeyStorageSecurityStandard(String keyStorageSecurityStandard)
Specifies a cryptographic key management compliance standard used for handling CA keys.
Default: FIPS_140_2_LEVEL_3_OR_HIGHER
Some Amazon Web Services Regions do not support the default. When creating a CA in these Regions, you must
provide FIPS_140_2_LEVEL_2_OR_HIGHER
as the argument for KeyStorageSecurityStandard
.
Failure to do this results in an InvalidArgsException
with the message,
"A certificate authority cannot be created in this region with the specified security standard."
For information about security standard support in various Regions, see Storage and security compliance of Amazon Web Services Private CA private keys.
keyStorageSecurityStandard
- Specifies a cryptographic key management compliance standard used for handling CA keys.
Default: FIPS_140_2_LEVEL_3_OR_HIGHER
Some Amazon Web Services Regions do not support the default. When creating a CA in these Regions, you must
provide FIPS_140_2_LEVEL_2_OR_HIGHER
as the argument for
KeyStorageSecurityStandard
. Failure to do this results in an
InvalidArgsException
with the message,
"A certificate authority cannot be created in this region with the specified security standard."
For information about security standard support in various Regions, see Storage and security compliance of Amazon Web Services Private CA private keys.
KeyStorageSecurityStandard
public String getKeyStorageSecurityStandard()
Specifies a cryptographic key management compliance standard used for handling CA keys.
Default: FIPS_140_2_LEVEL_3_OR_HIGHER
Some Amazon Web Services Regions do not support the default. When creating a CA in these Regions, you must
provide FIPS_140_2_LEVEL_2_OR_HIGHER
as the argument for KeyStorageSecurityStandard
.
Failure to do this results in an InvalidArgsException
with the message,
"A certificate authority cannot be created in this region with the specified security standard."
For information about security standard support in various Regions, see Storage and security compliance of Amazon Web Services Private CA private keys.
Default: FIPS_140_2_LEVEL_3_OR_HIGHER
Some Amazon Web Services Regions do not support the default. When creating a CA in these Regions, you
must provide FIPS_140_2_LEVEL_2_OR_HIGHER
as the argument for
KeyStorageSecurityStandard
. Failure to do this results in an
InvalidArgsException
with the message,
"A certificate authority cannot be created in this region with the specified security standard."
For information about security standard support in various Regions, see Storage and security compliance of Amazon Web Services Private CA private keys.
KeyStorageSecurityStandard
public CreateCertificateAuthorityRequest withKeyStorageSecurityStandard(String keyStorageSecurityStandard)
Specifies a cryptographic key management compliance standard used for handling CA keys.
Default: FIPS_140_2_LEVEL_3_OR_HIGHER
Some Amazon Web Services Regions do not support the default. When creating a CA in these Regions, you must
provide FIPS_140_2_LEVEL_2_OR_HIGHER
as the argument for KeyStorageSecurityStandard
.
Failure to do this results in an InvalidArgsException
with the message,
"A certificate authority cannot be created in this region with the specified security standard."
For information about security standard support in various Regions, see Storage and security compliance of Amazon Web Services Private CA private keys.
keyStorageSecurityStandard
- Specifies a cryptographic key management compliance standard used for handling CA keys.
Default: FIPS_140_2_LEVEL_3_OR_HIGHER
Some Amazon Web Services Regions do not support the default. When creating a CA in these Regions, you must
provide FIPS_140_2_LEVEL_2_OR_HIGHER
as the argument for
KeyStorageSecurityStandard
. Failure to do this results in an
InvalidArgsException
with the message,
"A certificate authority cannot be created in this region with the specified security standard."
For information about security standard support in various Regions, see Storage and security compliance of Amazon Web Services Private CA private keys.
KeyStorageSecurityStandard
public CreateCertificateAuthorityRequest withKeyStorageSecurityStandard(KeyStorageSecurityStandard keyStorageSecurityStandard)
Specifies a cryptographic key management compliance standard used for handling CA keys.
Default: FIPS_140_2_LEVEL_3_OR_HIGHER
Some Amazon Web Services Regions do not support the default. When creating a CA in these Regions, you must
provide FIPS_140_2_LEVEL_2_OR_HIGHER
as the argument for KeyStorageSecurityStandard
.
Failure to do this results in an InvalidArgsException
with the message,
"A certificate authority cannot be created in this region with the specified security standard."
For information about security standard support in various Regions, see Storage and security compliance of Amazon Web Services Private CA private keys.
keyStorageSecurityStandard
- Specifies a cryptographic key management compliance standard used for handling CA keys.
Default: FIPS_140_2_LEVEL_3_OR_HIGHER
Some Amazon Web Services Regions do not support the default. When creating a CA in these Regions, you must
provide FIPS_140_2_LEVEL_2_OR_HIGHER
as the argument for
KeyStorageSecurityStandard
. Failure to do this results in an
InvalidArgsException
with the message,
"A certificate authority cannot be created in this region with the specified security standard."
For information about security standard support in various Regions, see Storage and security compliance of Amazon Web Services Private CA private keys.
KeyStorageSecurityStandard
public List<Tag> getTags()
Key-value pairs that will be attached to the new private CA. You can associate up to 50 tags with a private CA. For information using tags with IAM to manage permissions, see Controlling Access Using IAM Tags.
public void setTags(Collection<Tag> tags)
Key-value pairs that will be attached to the new private CA. You can associate up to 50 tags with a private CA. For information using tags with IAM to manage permissions, see Controlling Access Using IAM Tags.
tags
- Key-value pairs that will be attached to the new private CA. You can associate up to 50 tags with a
private CA. For information using tags with IAM to manage permissions, see Controlling Access Using IAM
Tags.public CreateCertificateAuthorityRequest withTags(Tag... tags)
Key-value pairs that will be attached to the new private CA. You can associate up to 50 tags with a private CA. For information using tags with IAM to manage permissions, see Controlling Access Using IAM Tags.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- Key-value pairs that will be attached to the new private CA. You can associate up to 50 tags with a
private CA. For information using tags with IAM to manage permissions, see Controlling Access Using IAM
Tags.public CreateCertificateAuthorityRequest withTags(Collection<Tag> tags)
Key-value pairs that will be attached to the new private CA. You can associate up to 50 tags with a private CA. For information using tags with IAM to manage permissions, see Controlling Access Using IAM Tags.
tags
- Key-value pairs that will be attached to the new private CA. You can associate up to 50 tags with a
private CA. For information using tags with IAM to manage permissions, see Controlling Access Using IAM
Tags.public void setUsageMode(String usageMode)
Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. Short-lived certificate validity is limited to seven days.
The default value is GENERAL_PURPOSE.
usageMode
- Specifies whether the CA issues general-purpose certificates that typically require a revocation
mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly.
Short-lived certificate validity is limited to seven days.
The default value is GENERAL_PURPOSE.
CertificateAuthorityUsageMode
public String getUsageMode()
Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. Short-lived certificate validity is limited to seven days.
The default value is GENERAL_PURPOSE.
The default value is GENERAL_PURPOSE.
CertificateAuthorityUsageMode
public CreateCertificateAuthorityRequest withUsageMode(String usageMode)
Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. Short-lived certificate validity is limited to seven days.
The default value is GENERAL_PURPOSE.
usageMode
- Specifies whether the CA issues general-purpose certificates that typically require a revocation
mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly.
Short-lived certificate validity is limited to seven days.
The default value is GENERAL_PURPOSE.
CertificateAuthorityUsageMode
public CreateCertificateAuthorityRequest withUsageMode(CertificateAuthorityUsageMode usageMode)
Specifies whether the CA issues general-purpose certificates that typically require a revocation mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly. Short-lived certificate validity is limited to seven days.
The default value is GENERAL_PURPOSE.
usageMode
- Specifies whether the CA issues general-purpose certificates that typically require a revocation
mechanism, or short-lived certificates that may optionally omit revocation because they expire quickly.
Short-lived certificate validity is limited to seven days.
The default value is GENERAL_PURPOSE.
CertificateAuthorityUsageMode
public String toString()
toString
in class Object
Object.toString()
public CreateCertificateAuthorityRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()