Package software.amazon.awssdk.services.acmpca.model

Class CreateCertificateAuthorityRequest

    • Method Detail

      • certificateAuthorityConfiguration

        public final CertificateAuthorityConfiguration certificateAuthorityConfiguration()

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

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

      • revocationConfiguration

        public final RevocationConfiguration revocationConfiguration()

        Contains information to enable support for Online Certificate Status Protocol (OCSP), certificate revocation list (CRL), both protocols, or neither. By default, both certificate validation mechanisms are 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.

        Returns:
        Contains information to enable support for Online Certificate Status Protocol (OCSP), certificate revocation list (CRL), both protocols, or neither. By default, both certificate validation mechanisms are 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.

      • idempotencyToken

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

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

      • keyStorageSecurityStandard

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

        If the service returns an enum value that is not available in the current SDK version, keyStorageSecurityStandard will return KeyStorageSecurityStandard.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyStorageSecurityStandardAsString().

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

        See Also:
        KeyStorageSecurityStandard

      • keyStorageSecurityStandardAsString

        public final String keyStorageSecurityStandardAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, keyStorageSecurityStandard will return KeyStorageSecurityStandard.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyStorageSecurityStandardAsString().

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

        See Also:
        KeyStorageSecurityStandard

      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • tags

        public final List<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.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

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

      • usageMode

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

        If the service returns an enum value that is not available in the current SDK version, usageMode will return CertificateAuthorityUsageMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from usageModeAsString().

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

        See Also:
        CertificateAuthorityUsageMode

      • usageModeAsString

        public final String usageModeAsString()

        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.

        If the service returns an enum value that is not available in the current SDK version, usageMode will return CertificateAuthorityUsageMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from usageModeAsString().

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

        See Also:
        CertificateAuthorityUsageMode

      • toString

        public final 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