++ed by:
SKOLYCHEV GNUSTAVO KEEDI CAFEGRATZ DBOOK

17 PAUSE users
15 non-PAUSE users.

Jose Luis Martinez Torres
and 1 contributors

NAME

Paws::ACM::RequestCertificate - Arguments for method RequestCertificate on Paws::ACM

DESCRIPTION

This class represents the parameters used for calling the method RequestCertificate on the AWS Certificate Manager service. Use the attributes of this class as arguments to method RequestCertificate.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RequestCertificate.

SYNOPSIS

    my $acm = Paws->service('ACM');
    my $RequestCertificateResponse = $acm->RequestCertificate(
      DomainName              => 'MyDomainNameString',
      CertificateAuthorityArn => 'MyArn',                # OPTIONAL
      DomainValidationOptions => [
        {
          DomainName       => 'MyDomainNameString',      # min: 1, max: 253
          ValidationDomain => 'MyDomainNameString',      # min: 1, max: 253

        },
        ...
      ],                                                 # OPTIONAL
      IdempotencyToken => 'MyIdempotencyToken',          # OPTIONAL
      Options          => {
        CertificateTransparencyLoggingPreference =>
          'ENABLED',    # values: ENABLED, DISABLED; OPTIONAL
      },    # OPTIONAL
      SubjectAlternativeNames => [
        'MyDomainNameString', ...    # min: 1, max: 253
      ],                             # OPTIONAL
      ValidationMethod => 'EMAIL',   # OPTIONAL
    );

    # Results:
    my $CertificateArn = $RequestCertificateResponse->CertificateArn;

    # Returns a L<Paws::ACM::RequestCertificateResponse> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/acm/RequestCertificate

ATTRIBUTES

CertificateAuthorityArn => Str

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 AWS Certificate Manager Private Certificate Authority (PCA) (http://docs.aws.amazon.com/acm-pca/latest/userguide/PcaWelcome.html) user guide. The ARN must have the following form:

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

REQUIRED DomainName => Str

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.

The first domain name you enter cannot exceed 63 octets, including periods. Each subsequent Subject Alternative Name (SAN), however, can be up to 253 octets in length.

DomainValidationOptions => ArrayRef[Paws::ACM::DomainValidationOption]

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

IdempotencyToken => Str

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.

Options => Paws::ACM::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 (http://docs.aws.amazon.com/acm/latest/userguide/acm-bestpractices.html#best-practices-transparency).

SubjectAlternativeNames => ArrayRef[Str|Undef]

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 limit is 10 domain names. If you need more than 10 names, you must request a limit increase. For more information, see Limits (http://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html).

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.

ValidationMethod => Str

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 (http://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html) or validate with email (http://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html). We recommend that you use DNS validation.

Valid values are: "EMAIL", "DNS"

SEE ALSO

This class forms part of Paws, documenting arguments for method RequestCertificate in Paws::ACM

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues