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

Class: Aws::ACMPCA::Types::IssueCertificateRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb

Overview

Note:

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

{
  certificate_authority_arn: "Arn", # required
  csr: "data", # required
  signing_algorithm: "SHA256WITHECDSA", # required, accepts SHA256WITHECDSA, SHA384WITHECDSA, SHA512WITHECDSA, SHA256WITHRSA, SHA384WITHRSA, SHA512WITHRSA
  template_arn: "Arn",
  validity: { # required
    value: 1, # required
    type: "END_DATE", # required, accepts END_DATE, ABSOLUTE, DAYS, MONTHS, YEARS
  },
  idempotency_token: "IdempotencyToken",
}

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_authority_arnString

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

Returns:

  • (String)


1123
1124
1125
1126
1127
1128
1129
1130
1131
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 1123

class IssueCertificateRequest < Struct.new(
  :certificate_authority_arn,
  :csr,
  :signing_algorithm,
  :template_arn,
  :validity,
  :idempotency_token)
  include Aws::Structure
end

#csrString

The certificate signing request (CSR) for the certificate you want to issue. You can use the following OpenSSL command to create the CSR and a 2048 bit RSA private key.

openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr

If you have a configuration file, you can use the following OpenSSL command. The usr_cert block in the configuration file contains your X509 version 3 extensions.

openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 -days -365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr

Returns:

  • (String)


1123
1124
1125
1126
1127
1128
1129
1130
1131
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 1123

class IssueCertificateRequest < Struct.new(
  :certificate_authority_arn,
  :csr,
  :signing_algorithm,
  :template_arn,
  :validity,
  :idempotency_token)
  include Aws::Structure
end

#idempotency_tokenString

Custom string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens time out after one hour. Therefore, if you call IssueCertificate multiple times with the same idempotency token within 5 minutes, ACM Private CA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, PCA recognizes that you are requesting multiple certificates.

Returns:

  • (String)


1123
1124
1125
1126
1127
1128
1129
1130
1131
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 1123

class IssueCertificateRequest < Struct.new(
  :certificate_authority_arn,
  :csr,
  :signing_algorithm,
  :template_arn,
  :validity,
  :idempotency_token)
  include Aws::Structure
end

#signing_algorithmString

The name of the algorithm that will be used to sign the certificate to be issued.

Returns:

  • (String)


1123
1124
1125
1126
1127
1128
1129
1130
1131
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 1123

class IssueCertificateRequest < Struct.new(
  :certificate_authority_arn,
  :csr,
  :signing_algorithm,
  :template_arn,
  :validity,
  :idempotency_token)
  include Aws::Structure
end

#template_arnString

Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 template.

The following service-owned TemplateArn values are supported by ACM Private CA:

  • arn:aws:acm-pca:::template/EndEntityCertificate/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen0/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen1/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen2/V1

  • arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen3/V1

  • arn:aws:acm-pca:::template/RootCACertificate/V1

For more information, see Using Templates.

Returns:

  • (String)


1123
1124
1125
1126
1127
1128
1129
1130
1131
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 1123

class IssueCertificateRequest < Struct.new(
  :certificate_authority_arn,
  :csr,
  :signing_algorithm,
  :template_arn,
  :validity,
  :idempotency_token)
  include Aws::Structure
end

#validityTypes::Validity

The type of the validity period.

Returns:



1123
1124
1125
1126
1127
1128
1129
1130
1131
# File 'gems/aws-sdk-acmpca/lib/aws-sdk-acmpca/types.rb', line 1123

class IssueCertificateRequest < Struct.new(
  :certificate_authority_arn,
  :csr,
  :signing_algorithm,
  :template_arn,
  :validity,
  :idempotency_token)
  include Aws::Structure
end