1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package acm
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/acm/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Requests an ACM certificate for use with other Amazon Web Services services. To
// request an ACM certificate, you must specify a fully qualified domain name
// (FQDN) in the DomainName parameter. You can also specify additional FQDNs in
// the SubjectAlternativeNames parameter. If you are requesting a private
// certificate, domain validation is not required. If you are requesting a public
// certificate, each domain name that you specify must be validated to verify that
// you own or control the domain. You can use DNS validation (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html)
// or email validation (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html)
// . We recommend that you use DNS validation. ACM issues public certificates after
// receiving approval from the domain owner. ACM behavior differs from the RFC 6125 (https://datatracker.ietf.org/doc/html/rfc6125#appendix-B.2)
// specification of the certificate validation process. ACM first checks for a
// Subject Alternative Name, and, if it finds one, ignores the common name (CN).
// After successful completion of the RequestCertificate action, there is a delay
// of several seconds before you can retrieve information about the new
// certificate.
func (c *Client) RequestCertificate(ctx context.Context, params *RequestCertificateInput, optFns ...func(*Options)) (*RequestCertificateOutput, error) {
if params == nil {
params = &RequestCertificateInput{}
}
result, metadata, err := c.invokeOperation(ctx, "RequestCertificate", params, optFns, c.addOperationRequestCertificateMiddlewares)
if err != nil {
return nil, err
}
out := result.(*RequestCertificateOutput)
out.ResultMetadata = metadata
return out, nil
}
type RequestCertificateInput struct {
// 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 (https://datatracker.ietf.org/doc/html/rfc5280)
// , 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.
//
// This member is required.
DomainName *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 (https://docs.aws.amazon.com/privateca/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
CertificateAuthorityArn *string
// The domain name that you want ACM to use to send you emails so that you can
// validate domain ownership.
DomainValidationOptions []types.DomainValidationOption
// 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.
IdempotencyToken *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 AWS
// 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 AWS service where
// you plan to deploy your certificate. Default: RSA_2048
KeyAlgorithm types.KeyAlgorithm
// 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 (https://docs.aws.amazon.com/acm/latest/userguide/acm-bestpractices.html#best-practices-transparency)
// .
Options *types.CertificateOptions
// 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 (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.
SubjectAlternativeNames []string
// One or more resource tags to associate with the certificate.
Tags []types.Tag
// 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.
ValidationMethod types.ValidationMethod
noSmithyDocumentSerde
}
type RequestCertificateOutput struct {
// String that contains the ARN of the issued certificate. This must be of the
// form:
// arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012
CertificateArn *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationRequestCertificateMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpRequestCertificate{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpRequestCertificate{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "RequestCertificate"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpRequestCertificateValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opRequestCertificate(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opRequestCertificate(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "RequestCertificate",
}
}
|