Class: Aws::ACM::Types::RequestCertificateRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-acm/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#certificate_authority_arn ⇒ String

The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate. If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate. For more information about private CAs, see the [Amazon Web Services Private Certificate Authority] user guide. The ARN must have the following form:

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

[1]: docs.aws.amazon.com/privateca/latest/userguide/PcaWelcome.html

Returns:

  • (String) 


1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
 
# File 'lib/aws-sdk-acm/types.rb', line 1366

class RequestCertificateRequest < Struct.new(
  :domain_name,
  :validation_method,
  :subject_alternative_names,
  :idempotency_token,
  :domain_validation_options,
  :options,
  :certificate_authority_arn,
  :tags,
  :key_algorithm)
  SENSITIVE = []
  include Aws::Structure
end

#domain_name ⇒ String

Fully qualified domain name (FQDN), such as www.example.com, that you want to secure with an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com, site.example.com, and images.example.com.

In compliance with [RFC 5280], the length of the domain name (technically, the Common Name) that you provide cannot exceed 64 octets (characters), including periods. To add a longer domain name, specify it in the Subject Alternative Name field, which supports names up to 253 octets in length.

[1]: datatracker.ietf.org/doc/html/rfc5280

Returns:

  • (String) 


1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
 
# File 'lib/aws-sdk-acm/types.rb', line 1366

class RequestCertificateRequest < Struct.new(
  :domain_name,
  :validation_method,
  :subject_alternative_names,
  :idempotency_token,
  :domain_validation_options,
  :options,
  :certificate_authority_arn,
  :tags,
  :key_algorithm)
  SENSITIVE = []
  include Aws::Structure
end

#domain_validation_options ⇒ Array<Types::DomainValidationOption>

The domain name that you want ACM to use to send you emails so that you can validate domain ownership.

Returns:



1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
 
# File 'lib/aws-sdk-acm/types.rb', line 1366

class RequestCertificateRequest < Struct.new(
  :domain_name,
  :validation_method,
  :subject_alternative_names,
  :idempotency_token,
  :domain_validation_options,
  :options,
  :certificate_authority_arn,
  :tags,
  :key_algorithm)
  SENSITIVE = []
  include Aws::Structure
end

#idempotency_token ⇒ String

Customer chosen string that can be used to distinguish between calls to ‘RequestCertificate`. Idempotency tokens time out after one hour. Therefore, if you call `RequestCertificate` multiple times with the same idempotency token within one hour, ACM recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, ACM recognizes that you are requesting multiple certificates.

Returns:

  • (String) 


1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
 
# File 'lib/aws-sdk-acm/types.rb', line 1366

class RequestCertificateRequest < Struct.new(
  :domain_name,
  :validation_method,
  :subject_alternative_names,
  :idempotency_token,
  :domain_validation_options,
  :options,
  :certificate_authority_arn,
  :tags,
  :key_algorithm)
  SENSITIVE = []
  include Aws::Structure
end

#key_algorithm ⇒ String

Specifies the algorithm of the public and private key pair that your certificate uses to encrypt data. RSA is the default key algorithm for ACM certificates. Elliptic Curve Digital Signature Algorithm (ECDSA) keys are smaller, offering security comparable to RSA keys but with greater computing efficiency. However, ECDSA is not supported by all network clients. Some Amazon Web Services services may require RSA keys, or only support ECDSA keys of a particular size, while others allow the use of either RSA and ECDSA keys to ensure that compatibility is not broken. Check the requirements for the Amazon Web Services service where you plan to deploy your certificate. For more information about selecting an algorithm, see [Key algorithms].

<note markdown=“1”> Algorithms supported for an ACM certificate request include:

* `RSA_2048`

  • ‘EC_prime256v1`

  • ‘EC_secp384r1`

Other listed algorithms are for imported certificates only.

</note>

<note markdown=“1”> When you request a private PKI certificate signed by a CA from Amazon Web Services Private CA, the specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA’s secret key.

</note>

Default: RSA_2048

[1]: docs.aws.amazon.com/acm/latest/userguide/acm-certificate.html#algorithms

Returns:

  • (String) 


1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
 
# File 'lib/aws-sdk-acm/types.rb', line 1366

class RequestCertificateRequest < Struct.new(
  :domain_name,
  :validation_method,
  :subject_alternative_names,
  :idempotency_token,
  :domain_validation_options,
  :options,
  :certificate_authority_arn,
  :tags,
  :key_algorithm)
  SENSITIVE = []
  include Aws::Structure
end

#options ⇒ Types::CertificateOptions

Currently, you can use this parameter to specify whether to add the certificate to a certificate transparency log. Certificate transparency makes it possible to detect SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have not been logged typically produce an error message in a browser. For more information, see [Opting Out of Certificate Transparency Logging].

[1]: docs.aws.amazon.com/acm/latest/userguide/acm-bestpractices.html#best-practices-transparency

Returns:



1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
 
# File 'lib/aws-sdk-acm/types.rb', line 1366

class RequestCertificateRequest < Struct.new(
  :domain_name,
  :validation_method,
  :subject_alternative_names,
  :idempotency_token,
  :domain_validation_options,
  :options,
  :certificate_authority_arn,
  :tags,
  :key_algorithm)
  SENSITIVE = []
  include Aws::Structure
end

#subject_alternative_names ⇒ Array<String>

Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, add the name www.example.net to a certificate for which the ‘DomainName` field is www.example.com if users can reach your site by using either name. The maximum number of domain names that you can add to an ACM certificate is 100. However, the initial quota is 10 domain names. If you need more than 10 names, you must request a quota increase. For more information, see [Quotas].

The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples:

  • ‘(63 octets).(63 octets).(63 octets).(61 octets)` is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets.

  • ‘(64 octets).(63 octets).(63 octets).(61 octets)` is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets.

  • ‘(63 octets).(63 octets).(63 octets).(62 octets)` is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.

[1]: docs.aws.amazon.com/acm/latest/userguide/acm-limits.html

Returns:

  • (Array<String>) 


1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
 
# File 'lib/aws-sdk-acm/types.rb', line 1366

class RequestCertificateRequest < Struct.new(
  :domain_name,
  :validation_method,
  :subject_alternative_names,
  :idempotency_token,
  :domain_validation_options,
  :options,
  :certificate_authority_arn,
  :tags,
  :key_algorithm)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

One or more resource tags to associate with the certificate.

Returns:



1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
 
# File 'lib/aws-sdk-acm/types.rb', line 1366

class RequestCertificateRequest < Struct.new(
  :domain_name,
  :validation_method,
  :subject_alternative_names,
  :idempotency_token,
  :domain_validation_options,
  :options,
  :certificate_authority_arn,
  :tags,
  :key_algorithm)
  SENSITIVE = []
  include Aws::Structure
end

#validation_method ⇒ String

The method you want to use if you are requesting a public certificate to validate that you own or control domain. You can

validate with DNS][1

or [validate with email]. We recommend

that you use DNS validation.

[1]: docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html [2]: docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html

Returns:

  • (String) 


1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
 
# File 'lib/aws-sdk-acm/types.rb', line 1366

class RequestCertificateRequest < Struct.new(
  :domain_name,
  :validation_method,
  :subject_alternative_names,
  :idempotency_token,
  :domain_validation_options,
  :options,
  :certificate_authority_arn,
  :tags,
  :key_algorithm)
  SENSITIVE = []
  include Aws::Structure
end