You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ACMPCA::Types::CreateCertificateAuthorityRequest

Inherits:

Struct

• Object
• Struct
• Aws::ACMPCA::Types::CreateCertificateAuthorityRequest

Defined in:

gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb

Overview

Note:

When making an API call, you may pass CreateCertificateAuthorityRequest data as a hash:

{
  certificate_authority_configuration: { # required
    key_algorithm: "RSA_2048", # required, accepts RSA_2048, RSA_4096, EC_prime256v1, EC_secp384r1
    signing_algorithm: "SHA256WITHECDSA", # required, accepts SHA256WITHECDSA, SHA384WITHECDSA, SHA512WITHECDSA, SHA256WITHRSA, SHA384WITHRSA, SHA512WITHRSA
    subject: { # required
      country: "CountryCodeString",
      organization: "String64",
      organizational_unit: "String64",
      distinguished_name_qualifier: "DistinguishedNameQualifierString",
      state: "String128",
      common_name: "String64",
      serial_number: "String64",
      locality: "String128",
      title: "String64",
      surname: "String40",
      given_name: "String16",
      initials: "String5",
      pseudonym: "String128",
      generation_qualifier: "String3",
    },
  },
  revocation_configuration: {
    crl_configuration: {
      enabled: false, # required
      expiration_in_days: 1,
      custom_cname: "String253",
      s3_bucket_name: "String3To255",
    },
  },
  certificate_authority_type: "ROOT", # required, accepts ROOT, SUBORDINATE
  idempotency_token: "IdempotencyToken",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #certificate_authority_configuration ⇒ Types::CertificateAuthorityConfiguration

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

• #certificate_authority_type ⇒ String

  The type of the certificate authority.

• #idempotency_token ⇒ String

  Alphanumeric string that can be used to distinguish between calls to CreateCertificateAuthority.

• #revocation_configuration ⇒ Types::RevocationConfiguration

  Contains a Boolean value that you can use to enable a certification revocation list (CRL) for the CA, the name of the S3 bucket to which ACM Private CA will write the CRL, and an optional CNAME alias that you can use to hide the name of your bucket in the CRL Distribution Points extension of your CA certificate.

• #tags ⇒ Array<Types::Tag>

  Key-value pairs that will be attached to the new private CA.

Instance Attribute Details

#certificate_authority_configuration ⇒ Types::CertificateAuthorityConfiguration

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

Returns:

• (Types::CertificateAuthorityConfiguration)

# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 434

class CreateCertificateAuthorityRequest < Struct.new(
  :certificate_authority_configuration,
  :revocation_configuration,
  :certificate_authority_type,
  :idempotency_token,
  :tags)
  include Aws::Structure
end

#certificate_authority_type ⇒ String

The type of the certificate authority.

Returns:

• (String)

# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 434

class CreateCertificateAuthorityRequest < Struct.new(
  :certificate_authority_configuration,
  :revocation_configuration,
  :certificate_authority_type,
  :idempotency_token,
  :tags)
  include Aws::Structure
end

#idempotency_token ⇒ String

Alphanumeric string that can be used to distinguish between calls to CreateCertificateAuthority. Idempotency tokens time out after five minutes. Therefore, if you call CreateCertificateAuthority multiple times with the same idempotency token within a five minute period, ACM Private CA recognizes that you are requesting only one certificate. As a result, ACM Private CA issues only one. If you change the idempotency token for each call, however, ACM Private CA recognizes that you are requesting multiple certificates.

Returns:

• (String)

# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 434

class CreateCertificateAuthorityRequest < Struct.new(
  :certificate_authority_configuration,
  :revocation_configuration,
  :certificate_authority_type,
  :idempotency_token,
  :tags)
  include Aws::Structure
end

#revocation_configuration ⇒ Types::RevocationConfiguration

Contains a Boolean value that you can use to enable a certification revocation list (CRL) for the CA, the name of the S3 bucket to which ACM Private CA will write the CRL, and an optional CNAME alias that you can use to hide the name of your bucket in the CRL Distribution Points extension of your CA certificate. For more information, see the CrlConfiguration structure.

Returns:

• (Types::RevocationConfiguration)

# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 434

class CreateCertificateAuthorityRequest < Struct.new(
  :certificate_authority_configuration,
  :revocation_configuration,
  :certificate_authority_type,
  :idempotency_token,
  :tags)
  include Aws::Structure
end

#tags ⇒ Array<Types::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.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 434

class CreateCertificateAuthorityRequest < Struct.new(
  :certificate_authority_configuration,
  :revocation_configuration,
  :certificate_authority_type,
  :idempotency_token,
  :tags)
  include Aws::Structure
end