Struct aws_sdk_acmpca::operation::create_certificate_authority::CreateCertificateAuthorityInput

#[non_exhaustive]
pub struct CreateCertificateAuthorityInput {
    pub certificate_authority_configuration: Option<CertificateAuthorityConfiguration>,
    pub revocation_configuration: Option<RevocationConfiguration>,
    pub certificate_authority_type: Option<CertificateAuthorityType>,
    pub idempotency_token: Option<String>,
    pub key_storage_security_standard: Option<KeyStorageSecurityStandard>,
    pub tags: Option<Vec<Tag>>,
    pub usage_mode: Option<CertificateAuthorityUsageMode>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

certificate_authority_configuration: Option<CertificateAuthorityConfiguration>

Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate subject information.

revocation_configuration: Option<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.

certificate_authority_type: Option<CertificateAuthorityType>

The type of the certificate authority.

idempotency_token: Option<String>

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.

key_storage_security_standard: Option<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.

tags: Option<Vec<Tag>>

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.

usage_mode: Option<CertificateAuthorityUsageMode>

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.

Implementations

impl CreateCertificateAuthorityInput

pub fn certificate_authority_configuration( &self ) -> Option<&CertificateAuthorityConfiguration>

Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate subject information.

pub fn revocation_configuration(&self) -> Option<&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.

pub fn certificate_authority_type(&self) -> Option<&CertificateAuthorityType>

The type of the certificate authority.

pub fn idempotency_token(&self) -> Option<&str>

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.

pub fn key_storage_security_standard( &self ) -> Option<&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.

pub fn tags(&self) -> &[Tag]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

pub fn usage_mode(&self) -> Option<&CertificateAuthorityUsageMode>

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.

impl CreateCertificateAuthorityInput

pub fn builder() -> CreateCertificateAuthorityInputBuilder

Creates a new builder-style object to manufacture CreateCertificateAuthorityInput.

Trait Implementations

impl Clone for CreateCertificateAuthorityInput

fn clone(&self) -> CreateCertificateAuthorityInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateCertificateAuthorityInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateCertificateAuthorityInput

fn eq(&self, other: &CreateCertificateAuthorityInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateCertificateAuthorityInput