acm

package
v1.1.36 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 21, 2016 License: Apache-2.0 Imports: 10 Imported by: 429

Documentation

Overview

Package acm provides a client for AWS Certificate Manager.

Index

Examples

Constants

View Source 
const (
	// @enum CertificateStatus
	CertificateStatusPendingValidation = "PENDING_VALIDATION"
	// @enum CertificateStatus
	CertificateStatusIssued = "ISSUED"
	// @enum CertificateStatus
	CertificateStatusInactive = "INACTIVE"
	// @enum CertificateStatus
	CertificateStatusExpired = "EXPIRED"
	// @enum CertificateStatus
	CertificateStatusValidationTimedOut = "VALIDATION_TIMED_OUT"
	// @enum CertificateStatus
	CertificateStatusRevoked = "REVOKED"
	// @enum CertificateStatus
	CertificateStatusFailed = "FAILED"
)
View Source 
const (
	// @enum KeyAlgorithm
	KeyAlgorithmRsa2048 = "RSA_2048"
	// @enum KeyAlgorithm
	KeyAlgorithmEcPrime256v1 = "EC_prime256v1"
)
View Source 
const (
	// @enum RevocationReason
	RevocationReasonUnspecified = "UNSPECIFIED"
	// @enum RevocationReason
	RevocationReasonKeyCompromise = "KEY_COMPROMISE"
	// @enum RevocationReason
	RevocationReasonCaCompromise = "CA_COMPROMISE"
	// @enum RevocationReason
	RevocationReasonAffiliationChanged = "AFFILIATION_CHANGED"
	// @enum RevocationReason
	RevocationReasonSuperceded = "SUPERCEDED"
	// @enum RevocationReason
	RevocationReasonCessationOfOperation = "CESSATION_OF_OPERATION"
	// @enum RevocationReason
	RevocationReasonCertificateHold = "CERTIFICATE_HOLD"
	// @enum RevocationReason
	RevocationReasonRemoveFromCrl = "REMOVE_FROM_CRL"
	// @enum RevocationReason
	RevocationReasonPrivilegeWithdrawn = "PRIVILEGE_WITHDRAWN"
	// @enum RevocationReason
	RevocationReasonAACompromise = "A_A_COMPROMISE"
)
View Source 
const ServiceName = "acm"

A ServiceName is the name of the service the client will make API calls to.

Variables

This section is empty.

Functions

This section is empty.

Types

type ACM 

type ACM struct {
	*client.Client
}

Welcome to the AWS Certificate Manager (ACM) Command Reference. This guide provides descriptions, syntax, and usage examples for each ACM command. You can use AWS Certificate Manager to request ACM Certificates for your AWS-based websites and applications. For general information about using ACM and for more information about using the console, see the AWS Certificate Manager User Guide (http://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html). For more information about using the ACM API, see the AWS Certificate Manager API Reference (http://docs.aws.amazon.com/acm/latest/APIReference/Welcome.html). The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client's properties though.

func New 

func New(p client.ConfigProvider, cfgs ...*aws.Config) *ACM

New creates a new instance of the ACM client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example: 

// Create a ACM client from just a session.
svc := acm.New(mySession)

// Create a ACM client with additional configuration
svc := acm.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*ACM) AddTagsToCertificate added in v1.1.20 

func (c *ACM) AddTagsToCertificate(input *AddTagsToCertificateInput) (*AddTagsToCertificateOutput, error)

Adds one or more tags to an ACM Certificate. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. You specify the certificate on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair.

You can apply a tag to just one certificate if you want to identify a specific characteristic of that certificate, or you can apply the same tag to multiple certificates if you want to filter for a common relationship among those certificates. Similarly, you can apply the same tag to multiple resources if you want to specify a relationship among those resources. For example, you can add the same tag to an ACM Certificate and an Elastic Load Balancing load balancer to indicate that they are both used by the same website. For more information, see Tagging ACM Certificates (http://docs.aws.amazon.com/acm/latest/userguide/tags.html).

To remove one or more tags, use the RemoveTagsFromCertificate action. To view all of the tags that have been applied to the certificate, use the ListTagsForCertificate action.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/acm"
)

func main() {
	svc := acm.New(session.New())

	params := &acm.AddTagsToCertificateInput{
		CertificateArn: aws.String("Arn"), // Required
		Tags: []*acm.Tag{ // Required
			{ // Required
				Key:   aws.String("TagKey"), // Required
				Value: aws.String("TagValue"),
			},
			// More values...
		},
	}
	resp, err := svc.AddTagsToCertificate(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*ACM) AddTagsToCertificateRequest added in v1.1.20 

func (c *ACM) AddTagsToCertificateRequest(input *AddTagsToCertificateInput) (req *request.Request, output *AddTagsToCertificateOutput)

AddTagsToCertificateRequest generates a request for the AddTagsToCertificate operation.

func (*ACM) DeleteCertificate 

func (c *ACM) DeleteCertificate(input *DeleteCertificateInput) (*DeleteCertificateOutput, error)

Deletes an ACM Certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list of ACM Certificates that can be displayed by calling the ListCertificates action or be retrieved by calling the GetCertificate action. The certificate will not be available for use by other AWS services. 

You cannot delete an ACM Certificate that is being used by another AWS

service. To delete a certificate that is in use, the certificate association must first be removed.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/acm"
)

func main() {
	svc := acm.New(session.New())

	params := &acm.DeleteCertificateInput{
		CertificateArn: aws.String("Arn"), // Required
	}
	resp, err := svc.DeleteCertificate(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*ACM) DeleteCertificateRequest 

func (c *ACM) DeleteCertificateRequest(input *DeleteCertificateInput) (req *request.Request, output *DeleteCertificateOutput)

DeleteCertificateRequest generates a request for the DeleteCertificate operation.

func (*ACM) DescribeCertificate 

func (c *ACM) DescribeCertificate(input *DescribeCertificateInput) (*DescribeCertificateOutput, error)

Returns a list of the fields contained in the specified ACM Certificate. For example, this action returns the certificate status, a flag that indicates whether the certificate is associated with any other AWS service, and the date at which the certificate request was created. You specify the ACM Certificate on input by its Amazon Resource Name (ARN).

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/acm"
)

func main() {
	svc := acm.New(session.New())

	params := &acm.DescribeCertificateInput{
		CertificateArn: aws.String("Arn"), // Required
	}
	resp, err := svc.DescribeCertificate(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*ACM) DescribeCertificateRequest 

func (c *ACM) DescribeCertificateRequest(input *DescribeCertificateInput) (req *request.Request, output *DescribeCertificateOutput)

DescribeCertificateRequest generates a request for the DescribeCertificate operation.

func (*ACM) GetCertificate 

func (c *ACM) GetCertificate(input *GetCertificateInput) (*GetCertificateOutput, error)

Retrieves an ACM Certificate and certificate chain for the certificate specified by an ARN. The chain is an ordered list of certificates that contains the root certificate, intermediate certificates of subordinate CAs, and the ACM Certificate. The certificate and certificate chain are base64 encoded. If you want to decode the certificate chain to see the individual certificate fields, you can use OpenSSL. 

Currently, ACM Certificates can be used only with Elastic Load Balancing

and Amazon CloudFront.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/acm"
)

func main() {
	svc := acm.New(session.New())

	params := &acm.GetCertificateInput{
		CertificateArn: aws.String("Arn"), // Required
	}
	resp, err := svc.GetCertificate(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*ACM) GetCertificateRequest 

func (c *ACM) GetCertificateRequest(input *GetCertificateInput) (req *request.Request, output *GetCertificateOutput)

GetCertificateRequest generates a request for the GetCertificate operation.

func (*ACM) ListCertificates 

func (c *ACM) ListCertificates(input *ListCertificatesInput) (*ListCertificatesOutput, error)

Retrieves a list of ACM Certificates and the domain name for each. You can optionally filter the list to return only the certificates that match the specified status.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/acm"
)

func main() {
	svc := acm.New(session.New())

	params := &acm.ListCertificatesInput{
		CertificateStatuses: []*string{
			aws.String("CertificateStatus"), // Required
			// More values...
		},
		MaxItems:  aws.Int64(1),
		NextToken: aws.String("NextToken"),
	}
	resp, err := svc.ListCertificates(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*ACM) ListCertificatesPages 

func (c *ACM) ListCertificatesPages(input *ListCertificatesInput, fn func(p *ListCertificatesOutput, lastPage bool) (shouldContinue bool)) error

func (*ACM) ListCertificatesRequest 

func (c *ACM) ListCertificatesRequest(input *ListCertificatesInput) (req *request.Request, output *ListCertificatesOutput)

ListCertificatesRequest generates a request for the ListCertificates operation.

func (*ACM) ListTagsForCertificate added in v1.1.20 

func (c *ACM) ListTagsForCertificate(input *ListTagsForCertificateInput) (*ListTagsForCertificateOutput, error)

Lists the tags that have been applied to the ACM Certificate. Use the certificate ARN to specify the certificate. To add a tag to an ACM Certificate, use the AddTagsToCertificate action. To delete a tag, use the RemoveTagsFromCertificate action.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/acm"
)

func main() {
	svc := acm.New(session.New())

	params := &acm.ListTagsForCertificateInput{
		CertificateArn: aws.String("Arn"), // Required
	}
	resp, err := svc.ListTagsForCertificate(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*ACM) ListTagsForCertificateRequest added in v1.1.20 

func (c *ACM) ListTagsForCertificateRequest(input *ListTagsForCertificateInput) (req *request.Request, output *ListTagsForCertificateOutput)

ListTagsForCertificateRequest generates a request for the ListTagsForCertificate operation.

func (*ACM) RemoveTagsFromCertificate added in v1.1.20 

func (c *ACM) RemoveTagsFromCertificate(input *RemoveTagsFromCertificateInput) (*RemoveTagsFromCertificateOutput, error)

Remove one or more tags from an ACM Certificate. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value.

To add tags to a certificate, use the AddTagsToCertificate action. To view all of the tags that have been applied to a specific ACM Certificate, use the ListTagsForCertificate action.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/acm"
)

func main() {
	svc := acm.New(session.New())

	params := &acm.RemoveTagsFromCertificateInput{
		CertificateArn: aws.String("Arn"), // Required
		Tags: []*acm.Tag{ // Required
			{ // Required
				Key:   aws.String("TagKey"), // Required
				Value: aws.String("TagValue"),
			},
			// More values...
		},
	}
	resp, err := svc.RemoveTagsFromCertificate(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*ACM) RemoveTagsFromCertificateRequest added in v1.1.20 

func (c *ACM) RemoveTagsFromCertificateRequest(input *RemoveTagsFromCertificateInput) (req *request.Request, output *RemoveTagsFromCertificateOutput)

RemoveTagsFromCertificateRequest generates a request for the RemoveTagsFromCertificate operation.

func (*ACM) RequestCertificate 

func (c *ACM) RequestCertificate(input *RequestCertificateInput) (*RequestCertificateOutput, error)

Requests an ACM Certificate for use with other AWS services. To request an ACM Certificate, you must specify the fully qualified domain name (FQDN) for your site. You can also specify additional FQDNs if users can reach your site by using other names. For each domain name you specify, email is sent to the domain owner to request approval to issue the certificate. After receiving approval from the domain owner, the ACM Certificate is issued. For more information, see the AWS Certificate Manager User Guide (http://docs.aws.amazon.com/acm/latest/userguide/overview.html).

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/acm"
)

func main() {
	svc := acm.New(session.New())

	params := &acm.RequestCertificateInput{
		DomainName: aws.String("DomainNameString"), // Required
		DomainValidationOptions: []*acm.DomainValidationOption{
			{ // Required
				DomainName:       aws.String("DomainNameString"), // Required
				ValidationDomain: aws.String("DomainNameString"), // Required
			},
			// More values...
		},
		IdempotencyToken: aws.String("IdempotencyToken"),
		SubjectAlternativeNames: []*string{
			aws.String("DomainNameString"), // Required
			// More values...
		},
	}
	resp, err := svc.RequestCertificate(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*ACM) RequestCertificateRequest 

func (c *ACM) RequestCertificateRequest(input *RequestCertificateInput) (req *request.Request, output *RequestCertificateOutput)

RequestCertificateRequest generates a request for the RequestCertificate operation.

func (*ACM) ResendValidationEmail 

func (c *ACM) ResendValidationEmail(input *ResendValidationEmailInput) (*ResendValidationEmailOutput, error)

Resends the email that requests domain ownership validation. The domain owner or an authorized representative must approve the ACM Certificate before it can be issued. The certificate can be approved by clicking a link in the mail to navigate to the Amazon certificate approval website and then clicking I Approve. However, the validation email can be blocked by spam filters. Therefore, if you do not receive the original mail, you can request that the mail be resent within 72 hours of requesting the ACM Certificate. If more than 72 hours have elapsed since your original request or since your last attempt to resend validation mail, you must request a new certificate.

Example 
package main

import (
	"fmt"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/acm"
)

func main() {
	svc := acm.New(session.New())

	params := &acm.ResendValidationEmailInput{
		CertificateArn:   aws.String("Arn"),              // Required
		Domain:           aws.String("DomainNameString"), // Required
		ValidationDomain: aws.String("DomainNameString"), // Required
	}
	resp, err := svc.ResendValidationEmail(params)

	if err != nil {
		// Print the error, cast err to awserr.Error to get the Code and
		// Message from an error.
		fmt.Println(err.Error())
		return
	}

	// Pretty-print the response data.
	fmt.Println(resp)
}

Output:

func (*ACM) ResendValidationEmailRequest 

func (c *ACM) ResendValidationEmailRequest(input *ResendValidationEmailInput) (req *request.Request, output *ResendValidationEmailOutput)

ResendValidationEmailRequest generates a request for the ResendValidationEmail operation.

type AddTagsToCertificateInput added in v1.1.20 

type AddTagsToCertificateInput struct {

	// String that contains the ARN of the ACM Certificate to which the tag is to
	// be applied. This must be of the form:
	//
	//  arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
	//
	// For more information about ARNs, see Amazon Resource Names (ARNs) and AWS
	// Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
	CertificateArn *string `min:"20" type:"string" required:"true"`

	// The key-value pair that defines the tag. The tag value is optional.
	Tags []*Tag `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (AddTagsToCertificateInput) GoString added in v1.1.20 

func (s AddTagsToCertificateInput) GoString() string

GoString returns the string representation

func (AddTagsToCertificateInput) String added in v1.1.20 

func (s AddTagsToCertificateInput) String() string

String returns the string representation

func (*AddTagsToCertificateInput) Validate added in v1.1.21 

func (s *AddTagsToCertificateInput) Validate() error

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

type AddTagsToCertificateOutput added in v1.1.20 

type AddTagsToCertificateOutput struct {
	// contains filtered or unexported fields
}

func (AddTagsToCertificateOutput) GoString added in v1.1.20 

func (s AddTagsToCertificateOutput) GoString() string

GoString returns the string representation

func (AddTagsToCertificateOutput) String added in v1.1.20 

func (s AddTagsToCertificateOutput) String() string

String returns the string representation

type CertificateDetail 

type CertificateDetail struct {

	// The Amazon Resource Name (ARN) of the certificate. For more information about
	// ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
	CertificateArn *string `min:"20" type:"string"`

	// The time at which the certificate was requested.
	CreatedAt *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The fully qualified domain name (FQDN) for the certificate, such as www.example.com
	// or example.com.
	DomainName *string `min:"1" type:"string"`

	// Contains information about the email address or addresses used for domain
	// validation.
	DomainValidationOptions []*DomainValidation `min:"1" type:"list"`

	// A list of ARNs for the resources that are using the certificate. An ACM Certificate
	// can be used by multiple AWS resources.
	InUseBy []*string `type:"list"`

	// The time at which the certificate was issued.
	IssuedAt *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The X.500 distinguished name of the CA that issued and signed the certificate.
	Issuer *string `type:"string"`

	// The algorithm used to generate the key pair (the public and private key).
	// Currently the only supported value is RSA_2048.
	KeyAlgorithm *string `type:"string" enum:"KeyAlgorithm"`

	// The time after which the certificate is not valid.
	NotAfter *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The time before which the certificate is not valid.
	NotBefore *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The reason the certificate was revoked. This value exists only when the certificate
	// status is REVOKED.
	RevocationReason *string `type:"string" enum:"RevocationReason"`

	// The time at which the certificate was revoked. This value exists only when
	// the certificate status is REVOKED.
	RevokedAt *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The serial number of the certificate.
	Serial *string `type:"string"`

	// The algorithm used to generate a signature. Currently the only supported
	// value is SHA256WITHRSA.
	SignatureAlgorithm *string `type:"string"`

	// The status of the certificate.
	Status *string `type:"string" enum:"CertificateStatus"`

	// The X.500 distinguished name of the entity associated with the public key
	// contained in the certificate.
	Subject *string `type:"string"`

	// One or more domain names (subject alternative names) included in the certificate
	// request. After the certificate is issued, this list includes the domain names
	// bound to the public key contained in the certificate. The subject alternative
	// names include the canonical domain name (CN) of the certificate and additional
	// domain names that can be used to connect to the website.
	SubjectAlternativeNames []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

Contains detailed metadata about an ACM Certificate. This structure is returned in the response to a DescribeCertificate request.

func (CertificateDetail) GoString 

func (s CertificateDetail) GoString() string

GoString returns the string representation

func (CertificateDetail) String 

func (s CertificateDetail) String() string

String returns the string representation

type CertificateSummary 

type CertificateSummary struct {

	// Amazon Resource Name (ARN) of the certificate. This is of the form:
	//
	//  arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
	//
	// For more information about ARNs, see Amazon Resource Names (ARNs) and AWS
	// Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
	CertificateArn *string `min:"20" type:"string"`

	// Fully qualified domain name (FQDN), such as www.example.com or example.com,
	// for the certificate.
	DomainName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

This structure is returned in the response object of ListCertificates action.

func (CertificateSummary) GoString 

func (s CertificateSummary) GoString() string

GoString returns the string representation

func (CertificateSummary) String 

func (s CertificateSummary) String() string

String returns the string representation

type DeleteCertificateInput 

type DeleteCertificateInput struct {

	// String that contains the ARN of the ACM Certificate to be deleted. This must
	// be of the form:
	//
	//  arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
	//
	// For more information about ARNs, see Amazon Resource Names (ARNs) and AWS
	// Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
	CertificateArn *string `min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteCertificateInput) GoString 

func (s DeleteCertificateInput) GoString() string

GoString returns the string representation

func (DeleteCertificateInput) String 

func (s DeleteCertificateInput) String() string

String returns the string representation

func (*DeleteCertificateInput) Validate added in v1.1.21 

func (s *DeleteCertificateInput) Validate() error

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

type DeleteCertificateOutput 

type DeleteCertificateOutput struct {
	// contains filtered or unexported fields
}

func (DeleteCertificateOutput) GoString 

func (s DeleteCertificateOutput) GoString() string

GoString returns the string representation

func (DeleteCertificateOutput) String 

func (s DeleteCertificateOutput) String() string

String returns the string representation

type DescribeCertificateInput 

type DescribeCertificateInput struct {

	// String that contains an ACM Certificate ARN. The ARN must be of the form:
	//
	//  arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
	//
	// For more information about ARNs, see Amazon Resource Names (ARNs) and AWS
	// Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
	CertificateArn *string `min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeCertificateInput) GoString 

func (s DescribeCertificateInput) GoString() string

GoString returns the string representation

func (DescribeCertificateInput) String 

func (s DescribeCertificateInput) String() string

String returns the string representation

func (*DescribeCertificateInput) Validate added in v1.1.21 

func (s *DescribeCertificateInput) Validate() error

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

type DescribeCertificateOutput 

type DescribeCertificateOutput struct {

	// Contains a CertificateDetail structure that lists the fields of an ACM Certificate.
	Certificate *CertificateDetail `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeCertificateOutput) GoString 

func (s DescribeCertificateOutput) GoString() string

GoString returns the string representation

func (DescribeCertificateOutput) String 

func (s DescribeCertificateOutput) String() string

String returns the string representation

type DomainValidation 

type DomainValidation struct {

	// Fully Qualified Domain Name (FQDN) of the form www.example.com or  example.com.
	DomainName *string `min:"1" type:"string" required:"true"`

	// The base validation domain that acts as the suffix of the email addresses
	// that are used to send the emails.
	ValidationDomain *string `min:"1" type:"string"`

	// A list of contact address for the domain registrant.
	ValidationEmails []*string `type:"list"`
	// contains filtered or unexported fields
}

Structure that contains the domain name, the base validation domain to which validation email is sent, and the email addresses used to validate the domain identity.

func (DomainValidation) GoString 

func (s DomainValidation) GoString() string

GoString returns the string representation

func (DomainValidation) String 

func (s DomainValidation) String() string

String returns the string representation

type DomainValidationOption 

type DomainValidationOption struct {

	// Fully Qualified Domain Name (FQDN) of the certificate being requested.
	DomainName *string `min:"1" type:"string" required:"true"`

	// The domain to which validation email is sent. This is the base validation
	// domain that will act as the suffix of the email addresses. This must be the
	// same as the DomainName value or a superdomain of the DomainName value. For
	// example, if you requested a certificate for site.subdomain.example.com and
	// specify a ValidationDomain of subdomain.example.com, ACM sends email to the
	// domain registrant, technical contact, and administrative contact in WHOIS
	// for the base domain and the following five addresses:
	//
	//   admin@subdomain.example.com
	//
	//   administrator@subdomain.example.com
	//
	//   hostmaster@subdomain.example.com
	//
	//   postmaster@subdomain.example.com
	//
	//   webmaster@subdomain.example.com
	ValidationDomain *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

This structure is used in the request object of the RequestCertificate action.

func (DomainValidationOption) GoString 

func (s DomainValidationOption) GoString() string

GoString returns the string representation

func (DomainValidationOption) String 

func (s DomainValidationOption) String() string

String returns the string representation

func (*DomainValidationOption) Validate added in v1.1.21 

func (s *DomainValidationOption) Validate() error

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

type GetCertificateInput 

type GetCertificateInput struct {

	// String that contains a certificate ARN in the following format:
	//
	//  arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
	//
	// For more information about ARNs, see Amazon Resource Names (ARNs) and AWS
	// Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
	CertificateArn *string `min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetCertificateInput) GoString 

func (s GetCertificateInput) GoString() string

GoString returns the string representation

func (GetCertificateInput) String 

func (s GetCertificateInput) String() string

String returns the string representation

func (*GetCertificateInput) Validate added in v1.1.21 

func (s *GetCertificateInput) Validate() error

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

type GetCertificateOutput 

type GetCertificateOutput struct {

	// String that contains the ACM Certificate represented by the ARN specified
	// at input.
	Certificate *string `min:"1" type:"string"`

	// The certificate chain that contains the root certificate issued by the certificate
	// authority (CA).
	CertificateChain *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetCertificateOutput) GoString 

func (s GetCertificateOutput) GoString() string

GoString returns the string representation

func (GetCertificateOutput) String 

func (s GetCertificateOutput) String() string

String returns the string representation

type ListCertificatesInput 

type ListCertificatesInput struct {

	// The status or statuses on which to filter the list of ACM Certificates.
	CertificateStatuses []*string `type:"list"`

	// Use this parameter when paginating results to specify the maximum number
	// of items to return in the response. If additional items exist beyond the
	// number you specify, the NextToken element is sent in the response. Use this
	// NextToken value in a subsequent request to retrieve additional items.
	MaxItems *int64 `min:"1" type:"integer"`

	// Use this parameter only when paginating results and only in a subsequent
	// request after you receive a response with truncated results. Set it to the
	// value of NextToken from the response you just received.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListCertificatesInput) GoString 

func (s ListCertificatesInput) GoString() string

GoString returns the string representation

func (ListCertificatesInput) String 

func (s ListCertificatesInput) String() string

String returns the string representation

func (*ListCertificatesInput) Validate added in v1.1.21 

func (s *ListCertificatesInput) Validate() error

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

type ListCertificatesOutput 

type ListCertificatesOutput struct {

	// A list of ACM Certificates.
	CertificateSummaryList []*CertificateSummary `type:"list"`

	// When the list is truncated, this value is present and contains the value
	// to use for the NextToken parameter in a subsequent pagination request.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListCertificatesOutput) GoString 

func (s ListCertificatesOutput) GoString() string

GoString returns the string representation

func (ListCertificatesOutput) String 

func (s ListCertificatesOutput) String() string

String returns the string representation

type ListTagsForCertificateInput added in v1.1.20 

type ListTagsForCertificateInput struct {

	// String that contains the ARN of the ACM Certificate for which you want to
	// list the tags. This must be of the form:
	//
	//  arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
	//
	// For more information about ARNs, see Amazon Resource Names (ARNs) and AWS
	// Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
	CertificateArn *string `min:"20" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForCertificateInput) GoString added in v1.1.20 

func (s ListTagsForCertificateInput) GoString() string

GoString returns the string representation

func (ListTagsForCertificateInput) String added in v1.1.20 

func (s ListTagsForCertificateInput) String() string

String returns the string representation

func (*ListTagsForCertificateInput) Validate added in v1.1.21 

func (s *ListTagsForCertificateInput) Validate() error

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

type ListTagsForCertificateOutput added in v1.1.20 

type ListTagsForCertificateOutput struct {

	// The key-value pairs that define the applied tags.
	Tags []*Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForCertificateOutput) GoString added in v1.1.20 

func (s ListTagsForCertificateOutput) GoString() string

GoString returns the string representation

func (ListTagsForCertificateOutput) String added in v1.1.20 

func (s ListTagsForCertificateOutput) String() string

String returns the string representation

type RemoveTagsFromCertificateInput added in v1.1.20 

type RemoveTagsFromCertificateInput struct {

	// String that contains the ARN of the ACM Certificate with one or more tags
	// that you want to remove. This must be of the form:
	//
	//  arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
	//
	// For more information about ARNs, see Amazon Resource Names (ARNs) and AWS
	// Service Namespaces (http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html).
	CertificateArn *string `min:"20" type:"string" required:"true"`

	// The key-value pair that defines the tag to remove.
	Tags []*Tag `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (RemoveTagsFromCertificateInput) GoString added in v1.1.20 

func (s RemoveTagsFromCertificateInput) GoString() string

GoString returns the string representation

func (RemoveTagsFromCertificateInput) String added in v1.1.20 

func (s RemoveTagsFromCertificateInput) String() string

String returns the string representation

func (*RemoveTagsFromCertificateInput) Validate added in v1.1.21 

func (s *RemoveTagsFromCertificateInput) Validate() error

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

type RemoveTagsFromCertificateOutput added in v1.1.20 

type RemoveTagsFromCertificateOutput struct {
	// contains filtered or unexported fields
}

func (RemoveTagsFromCertificateOutput) GoString added in v1.1.20 

func (s RemoveTagsFromCertificateOutput) GoString() string

GoString returns the string representation

func (RemoveTagsFromCertificateOutput) String added in v1.1.20 

func (s RemoveTagsFromCertificateOutput) String() string

String returns the string representation

type RequestCertificateInput 

type RequestCertificateInput struct {

	// Fully qualified domain name (FQDN), such as www.example.com, of the site
	// 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.
	DomainName *string `min:"1" type:"string" required:"true"`

	// The base validation domain that will act as the suffix of the email addresses
	// that are used to send the emails. This must be the same as the Domain value
	// or a superdomain of the Domain value. For example, if you requested a certificate
	// for test.example.com and specify DomainValidationOptions of example.com,
	// ACM sends email to the domain registrant, technical contact, and administrative
	// contact in WHOIS and the following five addresses:
	//
	//   admin@example.com
	//
	//   administrator@example.com
	//
	//   hostmaster@example.com
	//
	//   postmaster@example.com
	//
	//   webmaster@example.com
	DomainValidationOptions []*DomainValidationOption `min:"1" type:"list"`

	// 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 `min:"1" 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.
	SubjectAlternativeNames []*string `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (RequestCertificateInput) GoString 

func (s RequestCertificateInput) GoString() string

GoString returns the string representation

func (RequestCertificateInput) String 

func (s RequestCertificateInput) String() string

String returns the string representation

func (*RequestCertificateInput) Validate added in v1.1.21 

func (s *RequestCertificateInput) Validate() error

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

type RequestCertificateOutput 

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 `min:"20" type:"string"`
	// contains filtered or unexported fields
}

func (RequestCertificateOutput) GoString 

func (s RequestCertificateOutput) GoString() string

GoString returns the string representation

func (RequestCertificateOutput) String 

func (s RequestCertificateOutput) String() string

String returns the string representation

type ResendValidationEmailInput 

type ResendValidationEmailInput struct {

	// String that contains the ARN of the requested certificate. The certificate
	// ARN is generated and returned by the RequestCertificate action as soon as
	// the request is made. By default, using this parameter causes email to be
	// sent to all top-level domains you specified in the certificate request.
	//
	// The ARN must be of the form:
	//
	//  arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012
	CertificateArn *string `min:"20" type:"string" required:"true"`

	// The Fully Qualified Domain Name (FQDN) of the certificate that needs to be
	// validated.
	Domain *string `min:"1" type:"string" required:"true"`

	// The base validation domain that will act as the suffix of the email addresses
	// that are used to send the emails. This must be the same as the Domain value
	// or a superdomain of the Domain value. For example, if you requested a certificate
	// for site.subdomain.example.com and specify a ValidationDomain of subdomain.example.com,
	// ACM sends email to the domain registrant, technical contact, and administrative
	// contact in WHOIS and the following five addresses:
	//
	//   admin@subdomain.example.com
	//
	//   administrator@subdomain.example.com
	//
	//   hostmaster@subdomain.example.com
	//
	//   postmaster@subdomain.example.com
	//
	//   webmaster@subdomain.example.com
	ValidationDomain *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ResendValidationEmailInput) GoString 

func (s ResendValidationEmailInput) GoString() string

GoString returns the string representation

func (ResendValidationEmailInput) String 

func (s ResendValidationEmailInput) String() string

String returns the string representation

func (*ResendValidationEmailInput) Validate added in v1.1.21 

func (s *ResendValidationEmailInput) Validate() error

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

type ResendValidationEmailOutput 

type ResendValidationEmailOutput struct {
	// contains filtered or unexported fields
}

func (ResendValidationEmailOutput) GoString 

func (s ResendValidationEmailOutput) GoString() string

GoString returns the string representation

func (ResendValidationEmailOutput) String 

func (s ResendValidationEmailOutput) String() string

String returns the string representation

type Tag added in v1.1.20 

type Tag struct {

	// The key of the tag.
	Key *string `min:"1" type:"string" required:"true"`

	// The value of the tag.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

A key-value pair that identifies or specifies metadata about an ACM resource.

func (Tag) GoString added in v1.1.20 

func (s Tag) GoString() string

GoString returns the string representation

func (Tag) String added in v1.1.20 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate added in v1.1.21 

func (s *Tag) Validate() error

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

Source Files

View all Source files

Directories

Path Synopsis
Package acmiface provides an interface for the AWS Certificate Manager.
 Package acmiface provides an interface for the AWS Certificate Manager.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.