AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

RequestCertificateInput

import "github.com/aws/aws-sdk-go/service/acm"

type RequestCertificateInput struct { CertificateAuthorityArn *string `min:"20" type:"string"` DomainName *string `min:"1" type:"string" required:"true"` DomainValidationOptions []*DomainValidationOption `min:"1" type:"list"` IdempotencyToken *string `min:"1" type:"string"` Options *CertificateOptions `type:"structure"` SubjectAlternativeNames []*string `min:"1" type:"list"` ValidationMethod *string `type:"string" enum:"ValidationMethod"` }

CertificateAuthorityArn

Type: *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 AWS Certificate Manager Private Certificate Authority (PCA) (https://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

DomainName

Type: *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.

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.

DomainName is a required field

DomainValidationOptions

Contains information about the domain names that you want ACM to use to send you emails that enable you to validate domain ownership.

IdempotencyToken

Type: *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.

Options

Structure that contains options for your certificate. Currently, you can use this only to specify whether to opt in to or out of certificate transparency logging. Some browsers require that public certificates issued for your domain be recorded in a log. Certificates that are not logged typically generate a browser error. Transparency makes it possible for you to detect SSL/TLS certificates that have been mistakenly or maliciously issued for your domain. For general information, see Certificate Transparency Logging (https://docs.aws.amazon.com/acm/latest/userguide/acm-concepts.html#concept-transparency).

SubjectAlternativeNames

Type: []*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 limit is 10 domain names. If you need more than 10 names, you must request a limit increase. For more information, see Limits (https://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

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

Method

GoString

func (s RequestCertificateInput) GoString() string

GoString returns the string representation

SetCertificateAuthorityArn

func (s *RequestCertificateInput) SetCertificateAuthorityArn(v string) *RequestCertificateInput

SetCertificateAuthorityArn sets the CertificateAuthorityArn field's value.

SetDomainName

func (s *RequestCertificateInput) SetDomainName(v string) *RequestCertificateInput

SetDomainName sets the DomainName field's value.

SetDomainValidationOptions

func (s *RequestCertificateInput) SetDomainValidationOptions(v []*DomainValidationOption) *RequestCertificateInput

SetDomainValidationOptions sets the DomainValidationOptions field's value.

SetIdempotencyToken

func (s *RequestCertificateInput) SetIdempotencyToken(v string) *RequestCertificateInput

SetIdempotencyToken sets the IdempotencyToken field's value.

SetOptions

func (s *RequestCertificateInput) SetOptions(v *CertificateOptions) *RequestCertificateInput

SetOptions sets the Options field's value.

SetSubjectAlternativeNames

func (s *RequestCertificateInput) SetSubjectAlternativeNames(v []*string) *RequestCertificateInput

SetSubjectAlternativeNames sets the SubjectAlternativeNames field's value.

SetValidationMethod

func (s *RequestCertificateInput) SetValidationMethod(v string) *RequestCertificateInput

SetValidationMethod sets the ValidationMethod field's value.

String

func (s RequestCertificateInput) String() string

String returns the string representation

Validate

func (s *RequestCertificateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: