acmpca

package
v0.24.0 Latest Latest
Warning

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

 Go to latest Published: Jul 22, 2020 License: Apache-2.0 Imports: 9 Imported by: 31

Documentation

Overview

Package acmpca provides the client and types for making API requests to ACM-PCA.

This is the ACM Private CA API Reference. It provides descriptions, syntax, and usage examples for each of the actions and data types involved in creating and managing private certificate authorities (CA) for your organization.

The documentation for each action shows the Query API request parameters and the XML response. Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see AWS SDKs (https://aws.amazon.com/tools/#SDKs).

Each ACM Private CA API action has a throttling limit which determines the number of times the action can be called per second. For more information, see API Rate Limits in ACM Private CA (https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaLimits.html#PcaLimits-api) in the ACM Private CA user guide.

See https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22 for more information on this service.

See acmpca package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/acmpca/

Using the Client

To use ACM-PCA with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the ACM-PCA client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/acmpca/#New

Index

Constants

View Source 
const (
	ServiceName = "ACM-PCA" // Service's name
	ServiceID   = "ACMPCA"  // Service's identifier
	EndpointsID = "acm-pca" // Service's Endpoint identifier
)
View Source 
const (

	// ErrCodeCertificateMismatchException for service response error code
	// "CertificateMismatchException".
	//
	// The certificate authority certificate you are importing does not comply with
	// conditions specified in the certificate that signed it.
	ErrCodeCertificateMismatchException = "CertificateMismatchException"

	// ErrCodeConcurrentModificationException for service response error code
	// "ConcurrentModificationException".
	//
	// A previous update to your private CA is still ongoing.
	ErrCodeConcurrentModificationException = "ConcurrentModificationException"

	// ErrCodeInvalidArgsException for service response error code
	// "InvalidArgsException".
	//
	// One or more of the specified arguments was not valid.
	ErrCodeInvalidArgsException = "InvalidArgsException"

	// ErrCodeInvalidArnException for service response error code
	// "InvalidArnException".
	//
	// The requested Amazon Resource Name (ARN) does not refer to an existing resource.
	ErrCodeInvalidArnException = "InvalidArnException"

	// ErrCodeInvalidNextTokenException for service response error code
	// "InvalidNextTokenException".
	//
	// The token specified in the NextToken argument is not valid. Use the token
	// returned from your previous call to ListCertificateAuthorities.
	ErrCodeInvalidNextTokenException = "InvalidNextTokenException"

	// ErrCodeInvalidPolicyException for service response error code
	// "InvalidPolicyException".
	//
	// The S3 bucket policy is not valid. The policy must give ACM Private CA rights
	// to read from and write to the bucket and find the bucket location.
	ErrCodeInvalidPolicyException = "InvalidPolicyException"

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	//
	// The request action cannot be performed or is prohibited.
	ErrCodeInvalidRequestException = "InvalidRequestException"

	// ErrCodeInvalidStateException for service response error code
	// "InvalidStateException".
	//
	// The private CA is in a state during which a report or certificate cannot
	// be generated.
	ErrCodeInvalidStateException = "InvalidStateException"

	// ErrCodeInvalidTagException for service response error code
	// "InvalidTagException".
	//
	// The tag associated with the CA is not valid. The invalid argument is contained
	// in the message field.
	ErrCodeInvalidTagException = "InvalidTagException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// An ACM Private CA limit has been exceeded. See the exception message returned
	// to determine the limit that was exceeded.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeMalformedCSRException for service response error code
	// "MalformedCSRException".
	//
	// The certificate signing request is invalid.
	ErrCodeMalformedCSRException = "MalformedCSRException"

	// ErrCodeMalformedCertificateException for service response error code
	// "MalformedCertificateException".
	//
	// One or more fields in the certificate are invalid.
	ErrCodeMalformedCertificateException = "MalformedCertificateException"

	// ErrCodePermissionAlreadyExistsException for service response error code
	// "PermissionAlreadyExistsException".
	//
	// The designated permission has already been given to the user.
	ErrCodePermissionAlreadyExistsException = "PermissionAlreadyExistsException"

	// ErrCodeRequestAlreadyProcessedException for service response error code
	// "RequestAlreadyProcessedException".
	//
	// Your request has already been completed.
	ErrCodeRequestAlreadyProcessedException = "RequestAlreadyProcessedException"

	// ErrCodeRequestFailedException for service response error code
	// "RequestFailedException".
	//
	// The request has failed for an unspecified reason.
	ErrCodeRequestFailedException = "RequestFailedException"

	// ErrCodeRequestInProgressException for service response error code
	// "RequestInProgressException".
	//
	// Your request is already in progress.
	ErrCodeRequestInProgressException = "RequestInProgressException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// A resource such as a private CA, S3 bucket, certificate, or audit report
	// cannot be found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeTooManyTagsException for service response error code
	// "TooManyTagsException".
	//
	// You can associate up to 50 tags with a private CA. Exception information
	// is contained in the exception message field.
	ErrCodeTooManyTagsException = "TooManyTagsException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN1Subject 

type ASN1Subject struct {

	// Fully qualified domain name (FQDN) associated with the certificate subject.
	CommonName *string `type:"string"`

	// Two-digit code that specifies the country in which the certificate subject
	// located.
	Country *string `type:"string"`

	// Disambiguating information for the certificate subject.
	DistinguishedNameQualifier *string `type:"string"`

	// Typically a qualifier appended to the name of an individual. Examples include
	// Jr. for junior, Sr. for senior, and III for third.
	GenerationQualifier *string `type:"string"`

	// First name.
	GivenName *string `type:"string"`

	// Concatenation that typically contains the first letter of the GivenName,
	// the first letter of the middle name if one exists, and the first letter of
	// the SurName.
	Initials *string `type:"string"`

	// The locality (such as a city or town) in which the certificate subject is
	// located.
	Locality *string `type:"string"`

	// Legal name of the organization with which the certificate subject is affiliated.
	Organization *string `type:"string"`

	// A subdivision or unit of the organization (such as sales or finance) with
	// which the certificate subject is affiliated.
	OrganizationalUnit *string `type:"string"`

	// Typically a shortened version of a longer GivenName. For example, Jonathan
	// is often shortened to John. Elizabeth is often shortened to Beth, Liz, or
	// Eliza.
	Pseudonym *string `type:"string"`

	// The certificate serial number.
	SerialNumber *string `type:"string"`

	// State in which the subject of the certificate is located.
	State *string `type:"string"`

	// Family name. In the US and the UK, for example, the surname of an individual
	// is ordered last. In Asian cultures the surname is typically ordered first.
	Surname *string `type:"string"`

	// A title such as Mr. or Ms., which is pre-pended to the name to refer formally
	// to the certificate subject.
	Title *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about the certificate subject. The certificate can be one issued by your private certificate authority (CA) or it can be your private CA certificate. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate. The DN must be unique for each entity, but your private CA can issue more than one certificate with the same DN to the same entity.

func (ASN1Subject) String 

func (s ASN1Subject) String() string

String returns the string representation

type ActionType added in v0.8.0 

type ActionType string
const (
	ActionTypeIssueCertificate ActionType = "IssueCertificate"
	ActionTypeGetCertificate   ActionType = "GetCertificate"
	ActionTypeListPermissions  ActionType = "ListPermissions"
)

Enum values for ActionType

func (ActionType) MarshalValue added in v0.8.0 

func (enum ActionType) MarshalValue() (string, error)

func (ActionType) MarshalValueBuf added in v0.8.0 

func (enum ActionType) MarshalValueBuf(b []byte) ([]byte, error)

type AuditReportResponseFormat 

type AuditReportResponseFormat string
const (
	AuditReportResponseFormatJson AuditReportResponseFormat = "JSON"
	AuditReportResponseFormatCsv  AuditReportResponseFormat = "CSV"
)

Enum values for AuditReportResponseFormat

func (AuditReportResponseFormat) MarshalValue 

func (enum AuditReportResponseFormat) MarshalValue() (string, error)

func (AuditReportResponseFormat) MarshalValueBuf 

func (enum AuditReportResponseFormat) MarshalValueBuf(b []byte) ([]byte, error)

type AuditReportStatus 

type AuditReportStatus string
const (
	AuditReportStatusCreating AuditReportStatus = "CREATING"
	AuditReportStatusSuccess  AuditReportStatus = "SUCCESS"
	AuditReportStatusFailed   AuditReportStatus = "FAILED"
)

Enum values for AuditReportStatus

func (AuditReportStatus) MarshalValue 

func (enum AuditReportStatus) MarshalValue() (string, error)

func (AuditReportStatus) MarshalValueBuf 

func (enum AuditReportStatus) MarshalValueBuf(b []byte) ([]byte, error)

type CertificateAuthority 

type CertificateAuthority struct {

	// Amazon Resource Name (ARN) for your private certificate authority (CA). The
	// format is 12345678-1234-1234-1234-123456789012 .
	Arn *string `min:"5" type:"string"`

	// Your private CA configuration.
	CertificateAuthorityConfiguration *CertificateAuthorityConfiguration `type:"structure"`

	// Date and time at which your private CA was created.
	CreatedAt *time.Time `type:"timestamp"`

	// Reason the request to create your private CA failed.
	FailureReason FailureReason `type:"string" enum:"true"`

	// Date and time at which your private CA was last updated.
	LastStateChangeAt *time.Time `type:"timestamp"`

	// Date and time after which your private CA certificate is not valid.
	NotAfter *time.Time `type:"timestamp"`

	// Date and time before which your private CA certificate is not valid.
	NotBefore *time.Time `type:"timestamp"`

	// The period during which a deleted CA can be restored. For more information,
	// see the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthorityRequest
	// action.
	RestorableUntil *time.Time `type:"timestamp"`

	// Information about the certificate revocation list (CRL) created and maintained
	// by your private CA.
	RevocationConfiguration *RevocationConfiguration `type:"structure"`

	// Serial number of your private CA.
	Serial *string `type:"string"`

	// Status of your private CA.
	Status CertificateAuthorityStatus `type:"string" enum:"true"`

	// Type of your private CA.
	Type CertificateAuthorityType `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Contains information about your private certificate authority (CA). Your private CA can issue and revoke X.509 digital certificates. Digital certificates verify that the entity named in the certificate Subject field owns or controls the public key contained in the Subject Public Key Info field. Call the CreateCertificateAuthority action to create your private CA. You must then call the GetCertificateAuthorityCertificate action to retrieve a private CA certificate signing request (CSR). Sign the CSR with your ACM Private CA-hosted or on-premises root or subordinate CA certificate. Call the ImportCertificateAuthorityCertificate action to import the signed certificate into AWS Certificate Manager (ACM).

func (CertificateAuthority) String 

func (s CertificateAuthority) String() string

String returns the string representation

type CertificateAuthorityConfiguration 

type CertificateAuthorityConfiguration struct {

	// Type of the public key algorithm and size, in bits, of the key pair that
	// your CA creates when it issues a certificate. When you create a subordinate
	// CA, you must use a key algorithm supported by the parent CA.
	//
	// KeyAlgorithm is a required field
	KeyAlgorithm KeyAlgorithm `type:"string" required:"true" enum:"true"`

	// Name of the algorithm your private CA uses to sign certificate requests.
	//
	// SigningAlgorithm is a required field
	SigningAlgorithm SigningAlgorithm `type:"string" required:"true" enum:"true"`

	// Structure that contains X.500 distinguished name information for your private
	// CA.
	//
	// Subject is a required field
	Subject *ASN1Subject `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Contains configuration information for your private certificate authority (CA). This includes information about the class of public key algorithm and the key pair that your private CA creates when it issues a certificate. It also includes the signature algorithm that it uses when issuing certificates, and its X.500 distinguished name. You must specify this information when you call the CreateCertificateAuthority action.

func (CertificateAuthorityConfiguration) String 

func (s CertificateAuthorityConfiguration) String() string

String returns the string representation

func (*CertificateAuthorityConfiguration) Validate 

func (s *CertificateAuthorityConfiguration) Validate() error

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

type CertificateAuthorityStatus 

type CertificateAuthorityStatus string
const (
	CertificateAuthorityStatusCreating           CertificateAuthorityStatus = "CREATING"
	CertificateAuthorityStatusPendingCertificate CertificateAuthorityStatus = "PENDING_CERTIFICATE"
	CertificateAuthorityStatusActive             CertificateAuthorityStatus = "ACTIVE"
	CertificateAuthorityStatusDeleted            CertificateAuthorityStatus = "DELETED"
	CertificateAuthorityStatusDisabled           CertificateAuthorityStatus = "DISABLED"
	CertificateAuthorityStatusExpired            CertificateAuthorityStatus = "EXPIRED"
	CertificateAuthorityStatusFailed             CertificateAuthorityStatus = "FAILED"
)

Enum values for CertificateAuthorityStatus

func (CertificateAuthorityStatus) MarshalValue 

func (enum CertificateAuthorityStatus) MarshalValue() (string, error)

func (CertificateAuthorityStatus) MarshalValueBuf 

func (enum CertificateAuthorityStatus) MarshalValueBuf(b []byte) ([]byte, error)

type CertificateAuthorityType 

type CertificateAuthorityType string
const (
	CertificateAuthorityTypeRoot        CertificateAuthorityType = "ROOT"
	CertificateAuthorityTypeSubordinate CertificateAuthorityType = "SUBORDINATE"
)

Enum values for CertificateAuthorityType

func (CertificateAuthorityType) MarshalValue 

func (enum CertificateAuthorityType) MarshalValue() (string, error)

func (CertificateAuthorityType) MarshalValueBuf 

func (enum CertificateAuthorityType) MarshalValueBuf(b []byte) ([]byte, error)

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to ACM-PCA. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := acmpca.New(myConfig)

func (*Client) CreateCertificateAuthorityAuditReportRequest added in v0.9.0 

func (c *Client) CreateCertificateAuthorityAuditReportRequest(input *CreateCertificateAuthorityAuditReportInput) CreateCertificateAuthorityAuditReportRequest

CreateCertificateAuthorityAuditReportRequest returns a request value for making API operation for AWS Certificate Manager Private Certificate Authority.

Creates an audit report that lists every time that your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The IssueCertificate and RevokeCertificate actions use the private key. 

// Example sending a request using CreateCertificateAuthorityAuditReportRequest.
req := client.CreateCertificateAuthorityAuditReportRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthorityAuditReport

func (*Client) CreateCertificateAuthorityRequest added in v0.9.0 

func (c *Client) CreateCertificateAuthorityRequest(input *CreateCertificateAuthorityInput) CreateCertificateAuthorityRequest

CreateCertificateAuthorityRequest returns a request value for making API operation for AWS Certificate Manager Private Certificate Authority.

Creates a root or subordinate private certificate authority (CA). You must specify the CA configuration, the certificate revocation list (CRL) configuration, the CA type, and an optional idempotency token to avoid accidental creation of multiple CAs. The CA configuration specifies the name of the algorithm and key size to be used to create the CA private key, the type of signing algorithm that the CA uses, and X.500 subject information. The CRL configuration specifies the CRL expiration period in days (the validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3 bucket that is included in certificates issued by the CA. If successful, this action returns the Amazon Resource Name (ARN) of the CA. 

// Example sending a request using CreateCertificateAuthorityRequest.
req := client.CreateCertificateAuthorityRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreateCertificateAuthority

func (*Client) CreatePermissionRequest added in v0.9.0 

func (c *Client) CreatePermissionRequest(input *CreatePermissionInput) CreatePermissionRequest

CreatePermissionRequest returns a request value for making API operation for AWS Certificate Manager Private Certificate Authority.

Assigns permissions from a private CA to a designated AWS service. Services are specified by their service principals and can be given permission to create and retrieve certificates on a private CA. Services can also be given permission to list the active permissions that the private CA has granted. For ACM to automatically renew your private CA's certificates, you must assign all possible permissions from the CA to the ACM service principal.

At this time, you can only assign permissions to ACM (acm.amazonaws.com). Permissions can be revoked with the DeletePermission action and listed with the ListPermissions action. 

// Example sending a request using CreatePermissionRequest.
req := client.CreatePermissionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/CreatePermission

func (*Client) DeleteCertificateAuthorityRequest added in v0.9.0 

func (c *Client) DeleteCertificateAuthorityRequest(input *DeleteCertificateAuthorityInput) DeleteCertificateAuthorityRequest

DeleteCertificateAuthorityRequest returns a request value for making API operation for AWS Certificate Manager Private Certificate Authority.

Deletes a private certificate authority (CA). You must provide the Amazon Resource Name (ARN) of the private CA that you want to delete. You can find the ARN by calling the ListCertificateAuthorities action.

Deleting a CA will invalidate other CAs and certificates below it in your CA hierarchy.

Before you can delete a CA that you have created and activated, you must disable it. To do this, call the UpdateCertificateAuthority action and set the CertificateAuthorityStatus parameter to DISABLED.

Additionally, you can delete a CA if you are waiting for it to be created (that is, the status of the CA is CREATING). You can also delete it if the CA has been created but you haven't yet imported the signed certificate into ACM Private CA (that is, the status of the CA is PENDING_CERTIFICATE).

When you successfully call DeleteCertificateAuthority, the CA's status changes to DELETED. However, the CA won't be permanently deleted until the restoration period has passed. By default, if you do not set the PermanentDeletionTimeInDays parameter, the CA remains restorable for 30 days. You can set the parameter from 7 to 30 days. The DescribeCertificateAuthority action returns the time remaining in the restoration window of a private CA in the DELETED state. To restore an eligible CA, call the RestoreCertificateAuthority action. 

// Example sending a request using DeleteCertificateAuthorityRequest.
req := client.DeleteCertificateAuthorityRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeleteCertificateAuthority

func (*Client) DeletePermissionRequest added in v0.9.0 

func (c *Client) DeletePermissionRequest(input *DeletePermissionInput) DeletePermissionRequest

DeletePermissionRequest returns a request value for making API operation for AWS Certificate Manager Private Certificate Authority.

Revokes permissions that a private CA assigned to a designated AWS service. Permissions can be created with the CreatePermission action and listed with the ListPermissions action. 

// Example sending a request using DeletePermissionRequest.
req := client.DeletePermissionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DeletePermission

func (*Client) DescribeCertificateAuthorityAuditReportRequest added in v0.9.0 

func (c *Client) DescribeCertificateAuthorityAuditReportRequest(input *DescribeCertificateAuthorityAuditReportInput) DescribeCertificateAuthorityAuditReportRequest

DescribeCertificateAuthorityAuditReportRequest returns a request value for making API operation for AWS Certificate Manager Private Certificate Authority.

Lists information about a specific audit report created by calling the CreateCertificateAuthorityAuditReport action. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the IssueCertificate action or the RevokeCertificate action. 

// Example sending a request using DescribeCertificateAuthorityAuditReportRequest.
req := client.DescribeCertificateAuthorityAuditReportRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthorityAuditReport

func (*Client) DescribeCertificateAuthorityRequest added in v0.9.0 

func (c *Client) DescribeCertificateAuthorityRequest(input *DescribeCertificateAuthorityInput) DescribeCertificateAuthorityRequest

DescribeCertificateAuthorityRequest returns a request value for making API operation for AWS Certificate Manager Private Certificate Authority.

Lists information about your private certificate authority (CA). You specify the private CA on input by its ARN (Amazon Resource Name). The output contains the status of your CA. This can be any of the following:

  • CREATING - ACM Private CA is creating your private certificate authority.

  • PENDING_CERTIFICATE - The certificate is pending. You must use your ACM Private CA-hosted or on-premises root or subordinate CA to sign your private CA CSR and then import it into PCA.

  • ACTIVE - Your private CA is active.

  • DISABLED - Your private CA has been disabled.

  • EXPIRED - Your private CA certificate has expired.

  • FAILED - Your private CA has failed. Your CA can fail because of problems such a network outage or backend AWS failure or other errors. A failed CA can never return to the pending state. You must create a new CA.

  • DELETED - Your private CA is within the restoration period, after which it is permanently deleted. The length of time remaining in the CA's restoration period is also included in this action's output.

    // Example sending a request using DescribeCertificateAuthorityRequest. req := client.DescribeCertificateAuthorityRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/DescribeCertificateAuthority

func (*Client) GetCertificateAuthorityCertificateRequest added in v0.9.0 

func (c *Client) GetCertificateAuthorityCertificateRequest(input *GetCertificateAuthorityCertificateInput) GetCertificateAuthorityCertificateRequest

GetCertificateAuthorityCertificateRequest returns a request value for making API operation for AWS Certificate Manager Private Certificate Authority.

Retrieves the certificate and certificate chain for your private certificate authority (CA). Both the certificate and the chain are base64 PEM-encoded. The chain does not include the CA certificate. Each certificate in the chain signs the one before it. 

// Example sending a request using GetCertificateAuthorityCertificateRequest.
req := client.GetCertificateAuthorityCertificateRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCertificate

func (*Client) GetCertificateAuthorityCsrRequest added in v0.9.0 

func (c *Client) GetCertificateAuthorityCsrRequest(input *GetCertificateAuthorityCsrInput) GetCertificateAuthorityCsrRequest

GetCertificateAuthorityCsrRequest returns a request value for making API operation for AWS Certificate Manager Private Certificate Authority.

Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created when you call the CreateCertificateAuthority action. Sign the CSR with your ACM Private CA-hosted or on-premises root or subordinate CA. Then import the signed certificate back into ACM Private CA by calling the ImportCertificateAuthorityCertificate action. The CSR is returned as a base64 PEM-encoded string. 

// Example sending a request using GetCertificateAuthorityCsrRequest.
req := client.GetCertificateAuthorityCsrRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificateAuthorityCsr

func (*Client) GetCertificateRequest added in v0.9.0 

func (c *Client) GetCertificateRequest(input *GetCertificateInput) GetCertificateRequest

GetCertificateRequest returns a request value for making API operation for AWS Certificate Manager Private Certificate Authority.

Retrieves a certificate from your private CA. The ARN of the certificate is returned when you call the IssueCertificate action. You must specify both the ARN of your private CA and the ARN of the issued certificate when calling the GetCertificate action. You can retrieve the certificate if it is in the ISSUED state. You can call the CreateCertificateAuthorityAuditReport action to create a report that contains information about all of the certificates issued and revoked by your private CA. 

// Example sending a request using GetCertificateRequest.
req := client.GetCertificateRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/GetCertificate

func (*Client) ImportCertificateAuthorityCertificateRequest added in v0.9.0 

func (c *Client) ImportCertificateAuthorityCertificateRequest(input *ImportCertificateAuthorityCertificateInput) ImportCertificateAuthorityCertificateRequest

ImportCertificateAuthorityCertificateRequest returns a request value for making API operation for AWS Certificate Manager Private Certificate Authority.

Imports a signed private CA certificate into ACM Private CA. This action is used when you are using a chain of trust whose root is located outside ACM Private CA. Before you can call this action, the following preparations must in place:

In ACM Private CA, call the CreateCertificateAuthority action to create the private CA that that you plan to back with the imported certificate.

Call the GetCertificateAuthorityCsr action to generate a certificate signing request (CSR).

Sign the CSR using a root or intermediate CA hosted either by an on-premises PKI hierarchy or a commercial CA..

Create a certificate chain and copy the signed certificate and the certificate chain to your working directory.

The following requirements apply when you import a CA certificate.

  • You cannot import a non-self-signed certificate for use as a root CA.

  • You cannot import a self-signed certificate for use as a subordinate CA.

  • Your certificate chain must not include the private CA certificate that you are importing.

  • Your ACM Private CA-hosted or on-premises CA certificate must be the last certificate in your chain. The subordinate certificate, if any, that your root CA signed must be next to last. The subordinate certificate signed by the preceding subordinate CA must come next, and so on until your chain is built.

  • The chain must be PEM-encoded.

    // Example sending a request using ImportCertificateAuthorityCertificateRequest. req := client.ImportCertificateAuthorityCertificateRequest(params) resp, err := req.Send(context.TODO()) if err == nil { fmt.Println(resp) }

Please also see https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ImportCertificateAuthorityCertificate

func (*Client) IssueCertificateRequest added in v0.9.0 

func (c *Client) IssueCertificateRequest(input *IssueCertificateInput) IssueCertificateRequest

IssueCertificateRequest returns a request value for making API operation for AWS Certificate Manager Private Certificate Authority.

Uses your private certificate authority (CA) to issue a client certificate. This action returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the GetCertificate action and specifying the ARN.

You cannot use the ACM ListCertificateAuthorities action to retrieve the ARNs of the certificates that you issue by using ACM Private CA. 

// Example sending a request using IssueCertificateRequest.
req := client.IssueCertificateRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/IssueCertificate

func (*Client) ListCertificateAuthoritiesRequest added in v0.9.0 

func (c *Client) ListCertificateAuthoritiesRequest(input *ListCertificateAuthoritiesInput) ListCertificateAuthoritiesRequest

ListCertificateAuthoritiesRequest returns a request value for making API operation for AWS Certificate Manager Private Certificate Authority.

Lists the private certificate authorities that you created by using the CreateCertificateAuthority action. 

// Example sending a request using ListCertificateAuthoritiesRequest.
req := client.ListCertificateAuthoritiesRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListCertificateAuthorities

func (*Client) ListPermissionsRequest added in v0.9.0 

func (c *Client) ListPermissionsRequest(input *ListPermissionsInput) ListPermissionsRequest

ListPermissionsRequest returns a request value for making API operation for AWS Certificate Manager Private Certificate Authority.

Lists all the permissions, if any, that have been assigned by a private CA. Permissions can be granted with the CreatePermission action and revoked with the DeletePermission action. 

// Example sending a request using ListPermissionsRequest.
req := client.ListPermissionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListPermissions

func (*Client) ListTagsRequest added in v0.9.0 

func (c *Client) ListTagsRequest(input *ListTagsInput) ListTagsRequest

ListTagsRequest returns a request value for making API operation for AWS Certificate Manager Private Certificate Authority.

Lists the tags, if any, that are associated with your private CA. Tags are labels that you can use to identify and organize your CAs. Each tag consists of a key and an optional value. Call the TagCertificateAuthority action to add one or more tags to your CA. Call the UntagCertificateAuthority action to remove tags. 

// Example sending a request using ListTagsRequest.
req := client.ListTagsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/ListTags

func (*Client) RestoreCertificateAuthorityRequest added in v0.9.0 

func (c *Client) RestoreCertificateAuthorityRequest(input *RestoreCertificateAuthorityInput) RestoreCertificateAuthorityRequest

RestoreCertificateAuthorityRequest returns a request value for making API operation for AWS Certificate Manager Private Certificate Authority.

Restores a certificate authority (CA) that is in the DELETED state. You can restore a CA during the period that you defined in the PermanentDeletionTimeInDays parameter of the DeleteCertificateAuthority action. Currently, you can specify 7 to 30 days. If you did not specify a PermanentDeletionTimeInDays value, by default you can restore the CA at any time in a 30 day period. You can check the time remaining in the restoration period of a private CA in the DELETED state by calling the DescribeCertificateAuthority or ListCertificateAuthorities actions. The status of a restored CA is set to its pre-deletion status when the RestoreCertificateAuthority action returns. To change its status to ACTIVE, call the UpdateCertificateAuthority action. If the private CA was in the PENDING_CERTIFICATE state at deletion, you must use the ImportCertificateAuthorityCertificate action to import a certificate authority into the private CA before it can be activated. You cannot restore a CA after the restoration period has ended. 

// Example sending a request using RestoreCertificateAuthorityRequest.
req := client.RestoreCertificateAuthorityRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/RestoreCertificateAuthority

func (*Client) RevokeCertificateRequest added in v0.9.0 

func (c *Client) RevokeCertificateRequest(input *RevokeCertificateInput) RevokeCertificateRequest

RevokeCertificateRequest returns a request value for making API operation for AWS Certificate Manager Private Certificate Authority.

Revokes a certificate that was issued inside ACM Private CA. If you enable a certificate revocation list (CRL) when you create or update your private CA, information about the revoked certificates will be included in the CRL. ACM Private CA writes the CRL to an S3 bucket that you specify. For more information about revocation, see the CrlConfiguration structure. ACM Private CA also writes revocation information to the audit report. For more information, see CreateCertificateAuthorityAuditReport.

You cannot revoke a root CA self-signed certificate. 

// Example sending a request using RevokeCertificateRequest.
req := client.RevokeCertificateRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/RevokeCertificate

func (*Client) TagCertificateAuthorityRequest added in v0.9.0 

func (c *Client) TagCertificateAuthorityRequest(input *TagCertificateAuthorityInput) TagCertificateAuthorityRequest

TagCertificateAuthorityRequest returns a request value for making API operation for AWS Certificate Manager Private Certificate Authority.

Adds one or more tags to your private CA. 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 private CA 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 private CA if you want to identify a specific characteristic of that CA, or you can apply the same tag to multiple private CAs if you want to filter for a common relationship among those CAs. To remove one or more tags, use the UntagCertificateAuthority action. Call the ListTags action to see what tags are associated with your CA. 

// Example sending a request using TagCertificateAuthorityRequest.
req := client.TagCertificateAuthorityRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/TagCertificateAuthority

func (*Client) UntagCertificateAuthorityRequest added in v0.9.0 

func (c *Client) UntagCertificateAuthorityRequest(input *UntagCertificateAuthorityInput) UntagCertificateAuthorityRequest

UntagCertificateAuthorityRequest returns a request value for making API operation for AWS Certificate Manager Private Certificate Authority.

Remove one or more tags from your private CA. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this action, 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 private CA, use the TagCertificateAuthority. Call the ListTags action to see what tags are associated with your CA. 

// Example sending a request using UntagCertificateAuthorityRequest.
req := client.UntagCertificateAuthorityRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/UntagCertificateAuthority

func (*Client) UpdateCertificateAuthorityRequest added in v0.9.0 

func (c *Client) UpdateCertificateAuthorityRequest(input *UpdateCertificateAuthorityInput) UpdateCertificateAuthorityRequest

UpdateCertificateAuthorityRequest returns a request value for making API operation for AWS Certificate Manager Private Certificate Authority.

Updates the status or configuration of a private certificate authority (CA). Your private CA must be in the ACTIVE or DISABLED state before you can update it. You can disable a private CA that is in the ACTIVE state or make a CA that is in the DISABLED state active again. 

// Example sending a request using UpdateCertificateAuthorityRequest.
req := client.UpdateCertificateAuthorityRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/acm-pca-2017-08-22/UpdateCertificateAuthority

func (*Client) WaitUntilAuditReportCreated added in v0.9.0 

func (c *Client) WaitUntilAuditReportCreated(ctx context.Context, input *DescribeCertificateAuthorityAuditReportInput, opts ...aws.WaiterOption) error

WaitUntilAuditReportCreated uses the ACM-PCA API operation DescribeCertificateAuthorityAuditReport to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Client) WaitUntilCertificateAuthorityCSRCreated added in v0.9.0 

func (c *Client) WaitUntilCertificateAuthorityCSRCreated(ctx context.Context, input *GetCertificateAuthorityCsrInput, opts ...aws.WaiterOption) error

WaitUntilCertificateAuthorityCSRCreated uses the ACM-PCA API operation GetCertificateAuthorityCsr to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Client) WaitUntilCertificateIssued added in v0.9.0 

func (c *Client) WaitUntilCertificateIssued(ctx context.Context, input *GetCertificateInput, opts ...aws.WaiterOption) error

WaitUntilCertificateIssued uses the ACM-PCA API operation GetCertificate to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type CreateCertificateAuthorityAuditReportInput 

type CreateCertificateAuthorityAuditReportInput struct {

	// The format in which to create the report. This can be either JSON or CSV.
	//
	// AuditReportResponseFormat is a required field
	AuditReportResponseFormat AuditReportResponseFormat `type:"string" required:"true" enum:"true"`

	// The Amazon Resource Name (ARN) of the CA to be audited. This is of the form:
	//
	// arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
	//
	// CertificateAuthorityArn is a required field
	CertificateAuthorityArn *string `min:"5" type:"string" required:"true"`

	// The name of the S3 bucket that will contain the audit report.
	//
	// S3BucketName is a required field
	S3BucketName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateCertificateAuthorityAuditReportInput) String 

func (s CreateCertificateAuthorityAuditReportInput) String() string

String returns the string representation

func (*CreateCertificateAuthorityAuditReportInput) Validate 

func (s *CreateCertificateAuthorityAuditReportInput) Validate() error

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

type CreateCertificateAuthorityAuditReportOutput 

type CreateCertificateAuthorityAuditReportOutput struct {

	// An alphanumeric string that contains a report identifier.
	AuditReportId *string `min:"36" type:"string"`

	// The key that uniquely identifies the report file in your S3 bucket.
	S3Key *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateCertificateAuthorityAuditReportOutput) String 

func (s CreateCertificateAuthorityAuditReportOutput) String() string

String returns the string representation

type CreateCertificateAuthorityAuditReportRequest 

type CreateCertificateAuthorityAuditReportRequest struct {
	*aws.Request
	Input *CreateCertificateAuthorityAuditReportInput
	Copy  func(*CreateCertificateAuthorityAuditReportInput) CreateCertificateAuthorityAuditReportRequest
}

CreateCertificateAuthorityAuditReportRequest is the request type for the CreateCertificateAuthorityAuditReport API operation.

func (CreateCertificateAuthorityAuditReportRequest) Send 

func (r CreateCertificateAuthorityAuditReportRequest) Send(ctx context.Context) (*CreateCertificateAuthorityAuditReportResponse, error)

Send marshals and sends the CreateCertificateAuthorityAuditReport API request.

type CreateCertificateAuthorityAuditReportResponse added in v0.9.0 

type CreateCertificateAuthorityAuditReportResponse struct {
	*CreateCertificateAuthorityAuditReportOutput
	// contains filtered or unexported fields
}

CreateCertificateAuthorityAuditReportResponse is the response type for the CreateCertificateAuthorityAuditReport API operation.

func (*CreateCertificateAuthorityAuditReportResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateCertificateAuthorityAuditReportResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateCertificateAuthorityAuditReport request.

type CreateCertificateAuthorityInput 

type CreateCertificateAuthorityInput struct {

	// Name and bit size of the private key algorithm, the name of the signing algorithm,
	// and X.500 certificate subject information.
	//
	// CertificateAuthorityConfiguration is a required field
	CertificateAuthorityConfiguration *CertificateAuthorityConfiguration `type:"structure" required:"true"`

	// The type of the certificate authority.
	//
	// CertificateAuthorityType is a required field
	CertificateAuthorityType CertificateAuthorityType `type:"string" required:"true" enum:"true"`

	// Alphanumeric string that can be used to distinguish between calls to CreateCertificateAuthority.
	// Idempotency tokens time out after five minutes. Therefore, if you call CreateCertificateAuthority
	// multiple times with the same idempotency token within a five minute period,
	// ACM Private CA recognizes that you are requesting only one certificate. As
	// a result, ACM Private CA issues only one. If you change the idempotency token
	// for each call, however, ACM Private CA recognizes that you are requesting
	// multiple certificates.
	IdempotencyToken *string `min:"1" type:"string"`

	// Contains a Boolean value that you can use to enable a certification revocation
	// list (CRL) for the CA, the name of the S3 bucket to which ACM Private CA
	// will write the CRL, and an optional CNAME alias that you can use to hide
	// the name of your bucket in the CRL Distribution Points extension of your
	// CA certificate. For more information, see the CrlConfiguration structure.
	RevocationConfiguration *RevocationConfiguration `type:"structure"`

	// Key-value pairs that will be attached to the new private CA. You can associate
	// up to 50 tags with a private CA. For information using tags with
	//
	// IAM to manage permissions, see Controlling Access Using IAM Tags (https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html).
	Tags []Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (CreateCertificateAuthorityInput) String 

func (s CreateCertificateAuthorityInput) String() string

String returns the string representation

func (*CreateCertificateAuthorityInput) Validate 

func (s *CreateCertificateAuthorityInput) Validate() error

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

type CreateCertificateAuthorityOutput 

type CreateCertificateAuthorityOutput struct {

	// If successful, the Amazon Resource Name (ARN) of the certificate authority
	// (CA). This is of the form:
	//
	// arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
	CertificateAuthorityArn *string `min:"5" type:"string"`
	// contains filtered or unexported fields
}

func (CreateCertificateAuthorityOutput) String 

func (s CreateCertificateAuthorityOutput) String() string

String returns the string representation

type CreateCertificateAuthorityRequest 

type CreateCertificateAuthorityRequest struct {
	*aws.Request
	Input *CreateCertificateAuthorityInput
	Copy  func(*CreateCertificateAuthorityInput) CreateCertificateAuthorityRequest
}

CreateCertificateAuthorityRequest is the request type for the CreateCertificateAuthority API operation.

func (CreateCertificateAuthorityRequest) Send 

func (r CreateCertificateAuthorityRequest) Send(ctx context.Context) (*CreateCertificateAuthorityResponse, error)

Send marshals and sends the CreateCertificateAuthority API request.

type CreateCertificateAuthorityResponse added in v0.9.0 

type CreateCertificateAuthorityResponse struct {
	*CreateCertificateAuthorityOutput
	// contains filtered or unexported fields
}

CreateCertificateAuthorityResponse is the response type for the CreateCertificateAuthority API operation.

func (*CreateCertificateAuthorityResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateCertificateAuthorityResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateCertificateAuthority request.

type CreatePermissionInput added in v0.8.0 

type CreatePermissionInput struct {

	// The actions that the specified AWS service principal can use. These include
	// IssueCertificate, GetCertificate, and ListPermissions.
	//
	// Actions is a required field
	Actions []ActionType `min:"1" type:"list" required:"true"`

	// The Amazon Resource Name (ARN) of the CA that grants the permissions. You
	// can find the ARN by calling the ListCertificateAuthorities action. This must
	// have the following form:
	//
	// arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
	//
	// CertificateAuthorityArn is a required field
	CertificateAuthorityArn *string `min:"5" type:"string" required:"true"`

	// The AWS service or identity that receives the permission. At this time, the
	// only valid principal is acm.amazonaws.com.
	//
	// Principal is a required field
	Principal *string `type:"string" required:"true"`

	// The ID of the calling account.
	SourceAccount *string `min:"12" type:"string"`
	// contains filtered or unexported fields
}

func (CreatePermissionInput) String added in v0.8.0 

func (s CreatePermissionInput) String() string

String returns the string representation

func (*CreatePermissionInput) Validate added in v0.8.0 

func (s *CreatePermissionInput) Validate() error

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

type CreatePermissionOutput added in v0.8.0 

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

func (CreatePermissionOutput) String added in v0.8.0 

func (s CreatePermissionOutput) String() string

String returns the string representation

type CreatePermissionRequest added in v0.8.0 

type CreatePermissionRequest struct {
	*aws.Request
	Input *CreatePermissionInput
	Copy  func(*CreatePermissionInput) CreatePermissionRequest
}

CreatePermissionRequest is the request type for the CreatePermission API operation.

func (CreatePermissionRequest) Send added in v0.8.0 

func (r CreatePermissionRequest) Send(ctx context.Context) (*CreatePermissionResponse, error)

Send marshals and sends the CreatePermission API request.

type CreatePermissionResponse added in v0.9.0 

type CreatePermissionResponse struct {
	*CreatePermissionOutput
	// contains filtered or unexported fields
}

CreatePermissionResponse is the response type for the CreatePermission API operation.

func (*CreatePermissionResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreatePermissionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreatePermission request.

type CrlConfiguration 

type CrlConfiguration struct {

	// Name inserted into the certificate CRL Distribution Points extension that
	// enables the use of an alias for the CRL distribution point. Use this value
	// if you don't want the name of your S3 bucket to be public.
	CustomCname *string `type:"string"`

	// Boolean value that specifies whether certificate revocation lists (CRLs)
	// are enabled. You can use this value to enable certificate revocation for
	// a new CA when you call the CreateCertificateAuthority action or for an existing
	// CA when you call the UpdateCertificateAuthority action.
	//
	// Enabled is a required field
	Enabled *bool `type:"boolean" required:"true"`

	// Number of days until a certificate expires.
	ExpirationInDays *int64 `min:"1" type:"integer"`

	// Name of the S3 bucket that contains the CRL. If you do not provide a value
	// for the CustomCname argument, the name of your S3 bucket is placed into the
	// CRL Distribution Points extension of the issued certificate. You can change
	// the name of your bucket by calling the UpdateCertificateAuthority action.
	// You must specify a bucket policy that allows ACM Private CA to write the
	// CRL to your bucket.
	S3BucketName *string `min:"3" type:"string"`
	// contains filtered or unexported fields
}

Contains configuration information for a certificate revocation list (CRL). Your private certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You can enable CRLs for your new or an existing private CA by setting the Enabled parameter to true. Your private CA writes CRLs to an S3 bucket that you specify in the S3BucketName parameter. You can hide the name of your bucket by specifying a value for the CustomCname parameter. Your private CA copies the CNAME or the S3 bucket name to the CRL Distribution Points extension of each certificate it issues. Your S3 bucket policy must give write permission to ACM Private CA.

Your private CA uses the value in the ExpirationInDays parameter to calculate the nextUpdate field in the CRL. The CRL is refreshed at 1/2 the age of next update or when a certificate is revoked. When a certificate is revoked, it is recorded in the next CRL that is generated and in the next audit report. Only time valid certificates are listed in the CRL. Expired certificates are not included.

CRLs contain the following fields:

  • Version: The current version number defined in RFC 5280 is V2. The integer value is 0x1.

  • Signature Algorithm: The name of the algorithm used to sign the CRL.

  • Issuer: The X.500 distinguished name of your private CA that issued the CRL.

  • Last Update: The issue date and time of this CRL.

  • Next Update: The day and time by which the next CRL will be issued.

  • Revoked Certificates: List of revoked certificates. Each list item contains the following information. Serial Number: The serial number, in hexadecimal format, of the revoked certificate. Revocation Date: Date and time the certificate was revoked. CRL Entry Extensions: Optional extensions for the CRL entry. X509v3 CRL Reason Code: Reason the certificate was revoked.

  • CRL Extensions: Optional extensions for the CRL. X509v3 Authority Key Identifier: Identifies the public key associated with the private key used to sign the certificate. X509v3 CRL Number:: Decimal sequence number for the CRL.

  • Signature Algorithm: Algorithm used by your private CA to sign the CRL.

  • Signature Value: Signature computed over the CRL.

Certificate revocation lists created by ACM Private CA are DER-encoded. You can use the following OpenSSL command to list a CRL.

openssl crl -inform DER -text -in crl_path -noout

func (CrlConfiguration) String 

func (s CrlConfiguration) String() string

String returns the string representation

func (*CrlConfiguration) Validate 

func (s *CrlConfiguration) Validate() error

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

type DeleteCertificateAuthorityInput 

type DeleteCertificateAuthorityInput struct {

	// The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority.
	// This must have the following form:
	//
	// arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
	//
	// CertificateAuthorityArn is a required field
	CertificateAuthorityArn *string `min:"5" type:"string" required:"true"`

	// The number of days to make a CA restorable after it has been deleted. This
	// can be anywhere from 7 to 30 days, with 30 being the default.
	PermanentDeletionTimeInDays *int64 `min:"7" type:"integer"`
	// contains filtered or unexported fields
}

func (DeleteCertificateAuthorityInput) String 

func (s DeleteCertificateAuthorityInput) String() string

String returns the string representation

func (*DeleteCertificateAuthorityInput) Validate 

func (s *DeleteCertificateAuthorityInput) Validate() error

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

type DeleteCertificateAuthorityOutput 

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

func (DeleteCertificateAuthorityOutput) String 

func (s DeleteCertificateAuthorityOutput) String() string

String returns the string representation

type DeleteCertificateAuthorityRequest 

type DeleteCertificateAuthorityRequest struct {
	*aws.Request
	Input *DeleteCertificateAuthorityInput
	Copy  func(*DeleteCertificateAuthorityInput) DeleteCertificateAuthorityRequest
}

DeleteCertificateAuthorityRequest is the request type for the DeleteCertificateAuthority API operation.

func (DeleteCertificateAuthorityRequest) Send 

func (r DeleteCertificateAuthorityRequest) Send(ctx context.Context) (*DeleteCertificateAuthorityResponse, error)

Send marshals and sends the DeleteCertificateAuthority API request.

type DeleteCertificateAuthorityResponse added in v0.9.0 

type DeleteCertificateAuthorityResponse struct {
	*DeleteCertificateAuthorityOutput
	// contains filtered or unexported fields
}

DeleteCertificateAuthorityResponse is the response type for the DeleteCertificateAuthority API operation.

func (*DeleteCertificateAuthorityResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteCertificateAuthorityResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteCertificateAuthority request.

type DeletePermissionInput added in v0.8.0 

type DeletePermissionInput struct {

	// The Amazon Resource Number (ARN) of the private CA that issued the permissions.
	// You can find the CA's ARN by calling the ListCertificateAuthorities action.
	// This must have the following form:
	//
	// arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
	//
	// CertificateAuthorityArn is a required field
	CertificateAuthorityArn *string `min:"5" type:"string" required:"true"`

	// The AWS service or identity that will have its CA permissions revoked. At
	// this time, the only valid service principal is acm.amazonaws.com
	//
	// Principal is a required field
	Principal *string `type:"string" required:"true"`

	// The AWS account that calls this action.
	SourceAccount *string `min:"12" type:"string"`
	// contains filtered or unexported fields
}

func (DeletePermissionInput) String added in v0.8.0 

func (s DeletePermissionInput) String() string

String returns the string representation

func (*DeletePermissionInput) Validate added in v0.8.0 

func (s *DeletePermissionInput) Validate() error

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

type DeletePermissionOutput added in v0.8.0 

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

func (DeletePermissionOutput) String added in v0.8.0 

func (s DeletePermissionOutput) String() string

String returns the string representation

type DeletePermissionRequest added in v0.8.0 

type DeletePermissionRequest struct {
	*aws.Request
	Input *DeletePermissionInput
	Copy  func(*DeletePermissionInput) DeletePermissionRequest
}

DeletePermissionRequest is the request type for the DeletePermission API operation.

func (DeletePermissionRequest) Send added in v0.8.0 

func (r DeletePermissionRequest) Send(ctx context.Context) (*DeletePermissionResponse, error)

Send marshals and sends the DeletePermission API request.

type DeletePermissionResponse added in v0.9.0 

type DeletePermissionResponse struct {
	*DeletePermissionOutput
	// contains filtered or unexported fields
}

DeletePermissionResponse is the response type for the DeletePermission API operation.

func (*DeletePermissionResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeletePermissionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeletePermission request.

type DescribeCertificateAuthorityAuditReportInput 

type DescribeCertificateAuthorityAuditReportInput struct {

	// The report ID returned by calling the CreateCertificateAuthorityAuditReport
	// action.
	//
	// AuditReportId is a required field
	AuditReportId *string `min:"36" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the private CA. This must be of the form:
	//
	// arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
	//
	// CertificateAuthorityArn is a required field
	CertificateAuthorityArn *string `min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeCertificateAuthorityAuditReportInput) String 

func (s DescribeCertificateAuthorityAuditReportInput) String() string

String returns the string representation

func (*DescribeCertificateAuthorityAuditReportInput) Validate 

func (s *DescribeCertificateAuthorityAuditReportInput) Validate() error

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

type DescribeCertificateAuthorityAuditReportOutput 

type DescribeCertificateAuthorityAuditReportOutput struct {

	// Specifies whether report creation is in progress, has succeeded, or has failed.
	AuditReportStatus AuditReportStatus `type:"string" enum:"true"`

	// The date and time at which the report was created.
	CreatedAt *time.Time `type:"timestamp"`

	// Name of the S3 bucket that contains the report.
	S3BucketName *string `type:"string"`

	// S3 key that uniquely identifies the report file in your S3 bucket.
	S3Key *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeCertificateAuthorityAuditReportOutput) String 

func (s DescribeCertificateAuthorityAuditReportOutput) String() string

String returns the string representation

type DescribeCertificateAuthorityAuditReportRequest 

type DescribeCertificateAuthorityAuditReportRequest struct {
	*aws.Request
	Input *DescribeCertificateAuthorityAuditReportInput
	Copy  func(*DescribeCertificateAuthorityAuditReportInput) DescribeCertificateAuthorityAuditReportRequest
}

DescribeCertificateAuthorityAuditReportRequest is the request type for the DescribeCertificateAuthorityAuditReport API operation.

func (DescribeCertificateAuthorityAuditReportRequest) Send 

func (r DescribeCertificateAuthorityAuditReportRequest) Send(ctx context.Context) (*DescribeCertificateAuthorityAuditReportResponse, error)

Send marshals and sends the DescribeCertificateAuthorityAuditReport API request.

type DescribeCertificateAuthorityAuditReportResponse added in v0.9.0 

type DescribeCertificateAuthorityAuditReportResponse struct {
	*DescribeCertificateAuthorityAuditReportOutput
	// contains filtered or unexported fields
}

DescribeCertificateAuthorityAuditReportResponse is the response type for the DescribeCertificateAuthorityAuditReport API operation.

func (*DescribeCertificateAuthorityAuditReportResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeCertificateAuthorityAuditReportResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeCertificateAuthorityAuditReport request.

type DescribeCertificateAuthorityInput 

type DescribeCertificateAuthorityInput struct {

	// The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority.
	// This must be of the form:
	//
	// arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
	//
	// CertificateAuthorityArn is a required field
	CertificateAuthorityArn *string `min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeCertificateAuthorityInput) String 

func (s DescribeCertificateAuthorityInput) String() string

String returns the string representation

func (*DescribeCertificateAuthorityInput) Validate 

func (s *DescribeCertificateAuthorityInput) Validate() error

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

type DescribeCertificateAuthorityOutput 

type DescribeCertificateAuthorityOutput struct {

	// A CertificateAuthority structure that contains information about your private
	// CA.
	CertificateAuthority *CertificateAuthority `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeCertificateAuthorityOutput) String 

func (s DescribeCertificateAuthorityOutput) String() string

String returns the string representation

type DescribeCertificateAuthorityRequest 

type DescribeCertificateAuthorityRequest struct {
	*aws.Request
	Input *DescribeCertificateAuthorityInput
	Copy  func(*DescribeCertificateAuthorityInput) DescribeCertificateAuthorityRequest
}

DescribeCertificateAuthorityRequest is the request type for the DescribeCertificateAuthority API operation.

func (DescribeCertificateAuthorityRequest) Send 

func (r DescribeCertificateAuthorityRequest) Send(ctx context.Context) (*DescribeCertificateAuthorityResponse, error)

Send marshals and sends the DescribeCertificateAuthority API request.

type DescribeCertificateAuthorityResponse added in v0.9.0 

type DescribeCertificateAuthorityResponse struct {
	*DescribeCertificateAuthorityOutput
	// contains filtered or unexported fields
}

DescribeCertificateAuthorityResponse is the response type for the DescribeCertificateAuthority API operation.

func (*DescribeCertificateAuthorityResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeCertificateAuthorityResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeCertificateAuthority request.

type FailureReason 

type FailureReason string
const (
	FailureReasonRequestTimedOut      FailureReason = "REQUEST_TIMED_OUT"
	FailureReasonUnsupportedAlgorithm FailureReason = "UNSUPPORTED_ALGORITHM"
	FailureReasonOther                FailureReason = "OTHER"
)

Enum values for FailureReason

func (FailureReason) MarshalValue 

func (enum FailureReason) MarshalValue() (string, error)

func (FailureReason) MarshalValueBuf 

func (enum FailureReason) MarshalValueBuf(b []byte) ([]byte, error)

type GetCertificateAuthorityCertificateInput 

type GetCertificateAuthorityCertificateInput struct {

	// The Amazon Resource Name (ARN) of your private CA. This is of the form:
	//
	// arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
	//
	// CertificateAuthorityArn is a required field
	CertificateAuthorityArn *string `min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetCertificateAuthorityCertificateInput) String 

func (s GetCertificateAuthorityCertificateInput) String() string

String returns the string representation

func (*GetCertificateAuthorityCertificateInput) Validate 

func (s *GetCertificateAuthorityCertificateInput) Validate() error

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

type GetCertificateAuthorityCertificateOutput 

type GetCertificateAuthorityCertificateOutput struct {

	// Base64-encoded certificate authority (CA) certificate.
	Certificate *string `type:"string"`

	// Base64-encoded certificate chain that includes any intermediate certificates
	// and chains up to root on-premises certificate that you used to sign your
	// private CA certificate. The chain does not include your private CA certificate.
	// If this is a root CA, the value will be null.
	CertificateChain *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetCertificateAuthorityCertificateOutput) String 

func (s GetCertificateAuthorityCertificateOutput) String() string

String returns the string representation

type GetCertificateAuthorityCertificateRequest 

type GetCertificateAuthorityCertificateRequest struct {
	*aws.Request
	Input *GetCertificateAuthorityCertificateInput
	Copy  func(*GetCertificateAuthorityCertificateInput) GetCertificateAuthorityCertificateRequest
}

GetCertificateAuthorityCertificateRequest is the request type for the GetCertificateAuthorityCertificate API operation.

func (GetCertificateAuthorityCertificateRequest) Send 

func (r GetCertificateAuthorityCertificateRequest) Send(ctx context.Context) (*GetCertificateAuthorityCertificateResponse, error)

Send marshals and sends the GetCertificateAuthorityCertificate API request.

type GetCertificateAuthorityCertificateResponse added in v0.9.0 

type GetCertificateAuthorityCertificateResponse struct {
	*GetCertificateAuthorityCertificateOutput
	// contains filtered or unexported fields
}

GetCertificateAuthorityCertificateResponse is the response type for the GetCertificateAuthorityCertificate API operation.

func (*GetCertificateAuthorityCertificateResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetCertificateAuthorityCertificateResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetCertificateAuthorityCertificate request.

type GetCertificateAuthorityCsrInput 

type GetCertificateAuthorityCsrInput struct {

	// The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority
	// action. This must be of the form:
	//
	// arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
	//
	// CertificateAuthorityArn is a required field
	CertificateAuthorityArn *string `min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetCertificateAuthorityCsrInput) String 

func (s GetCertificateAuthorityCsrInput) String() string

String returns the string representation

func (*GetCertificateAuthorityCsrInput) Validate 

func (s *GetCertificateAuthorityCsrInput) Validate() error

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

type GetCertificateAuthorityCsrOutput 

type GetCertificateAuthorityCsrOutput struct {

	// The base64 PEM-encoded certificate signing request (CSR) for your private
	// CA certificate.
	Csr *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetCertificateAuthorityCsrOutput) String 

func (s GetCertificateAuthorityCsrOutput) String() string

String returns the string representation

type GetCertificateAuthorityCsrRequest 

type GetCertificateAuthorityCsrRequest struct {
	*aws.Request
	Input *GetCertificateAuthorityCsrInput
	Copy  func(*GetCertificateAuthorityCsrInput) GetCertificateAuthorityCsrRequest
}

GetCertificateAuthorityCsrRequest is the request type for the GetCertificateAuthorityCsr API operation.

func (GetCertificateAuthorityCsrRequest) Send 

func (r GetCertificateAuthorityCsrRequest) Send(ctx context.Context) (*GetCertificateAuthorityCsrResponse, error)

Send marshals and sends the GetCertificateAuthorityCsr API request.

type GetCertificateAuthorityCsrResponse added in v0.9.0 

type GetCertificateAuthorityCsrResponse struct {
	*GetCertificateAuthorityCsrOutput
	// contains filtered or unexported fields
}

GetCertificateAuthorityCsrResponse is the response type for the GetCertificateAuthorityCsr API operation.

func (*GetCertificateAuthorityCsrResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetCertificateAuthorityCsrResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetCertificateAuthorityCsr request.

type GetCertificateInput 

type GetCertificateInput struct {

	// The ARN of the issued certificate. The ARN contains the certificate serial
	// number and must be in the following form:
	//
	// arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245
	//
	// CertificateArn is a required field
	CertificateArn *string `min:"5" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority.
	// This must be of the form:
	//
	// arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
	//
	// CertificateAuthorityArn is a required field
	CertificateAuthorityArn *string `min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetCertificateInput) String 

func (s GetCertificateInput) String() string

String returns the string representation

func (*GetCertificateInput) Validate 

func (s *GetCertificateInput) Validate() error

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

type GetCertificateOutput 

type GetCertificateOutput struct {

	// The base64 PEM-encoded certificate specified by the CertificateArn parameter.
	Certificate *string `type:"string"`

	// The base64 PEM-encoded certificate chain that chains up to the on-premises
	// root CA certificate that you used to sign your private CA certificate.
	CertificateChain *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetCertificateOutput) String 

func (s GetCertificateOutput) String() string

String returns the string representation

type GetCertificateRequest 

type GetCertificateRequest struct {
	*aws.Request
	Input *GetCertificateInput
	Copy  func(*GetCertificateInput) GetCertificateRequest
}

GetCertificateRequest is the request type for the GetCertificate API operation.

func (GetCertificateRequest) Send 

func (r GetCertificateRequest) Send(ctx context.Context) (*GetCertificateResponse, error)

Send marshals and sends the GetCertificate API request.

type GetCertificateResponse added in v0.9.0 

type GetCertificateResponse struct {
	*GetCertificateOutput
	// contains filtered or unexported fields
}

GetCertificateResponse is the response type for the GetCertificate API operation.

func (*GetCertificateResponse) SDKResponseMetdata added in v0.9.0 

func (r *GetCertificateResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetCertificate request.

type ImportCertificateAuthorityCertificateInput 

type ImportCertificateAuthorityCertificateInput struct {

	// The PEM-encoded certificate for a private CA. This may be a self-signed certificate
	// in the case of a root CA, or it may be signed by another CA that you control.
	//
	// Certificate is automatically base64 encoded/decoded by the SDK.
	//
	// Certificate is a required field
	Certificate []byte `min:"1" type:"blob" required:"true"`

	// The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority.
	// This must be of the form:
	//
	// arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
	//
	// CertificateAuthorityArn is a required field
	CertificateAuthorityArn *string `min:"5" type:"string" required:"true"`

	// A PEM-encoded file that contains all of your certificates, other than the
	// certificate you're importing, chaining up to your root CA. Your ACM Private
	// CA-hosted or on-premises root certificate is the last in the chain, and each
	// certificate in the chain signs the one preceding.
	//
	// This parameter must be supplied when you import a subordinate CA. When you
	// import a root CA, there is no chain.
	//
	// CertificateChain is automatically base64 encoded/decoded by the SDK.
	CertificateChain []byte `type:"blob"`
	// contains filtered or unexported fields
}

func (ImportCertificateAuthorityCertificateInput) String 

func (s ImportCertificateAuthorityCertificateInput) String() string

String returns the string representation

func (*ImportCertificateAuthorityCertificateInput) Validate 

func (s *ImportCertificateAuthorityCertificateInput) Validate() error

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

type ImportCertificateAuthorityCertificateOutput 

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

func (ImportCertificateAuthorityCertificateOutput) String 

func (s ImportCertificateAuthorityCertificateOutput) String() string

String returns the string representation

type ImportCertificateAuthorityCertificateRequest 

type ImportCertificateAuthorityCertificateRequest struct {
	*aws.Request
	Input *ImportCertificateAuthorityCertificateInput
	Copy  func(*ImportCertificateAuthorityCertificateInput) ImportCertificateAuthorityCertificateRequest
}

ImportCertificateAuthorityCertificateRequest is the request type for the ImportCertificateAuthorityCertificate API operation.

func (ImportCertificateAuthorityCertificateRequest) Send 

func (r ImportCertificateAuthorityCertificateRequest) Send(ctx context.Context) (*ImportCertificateAuthorityCertificateResponse, error)

Send marshals and sends the ImportCertificateAuthorityCertificate API request.

type ImportCertificateAuthorityCertificateResponse added in v0.9.0 

type ImportCertificateAuthorityCertificateResponse struct {
	*ImportCertificateAuthorityCertificateOutput
	// contains filtered or unexported fields
}

ImportCertificateAuthorityCertificateResponse is the response type for the ImportCertificateAuthorityCertificate API operation.

func (*ImportCertificateAuthorityCertificateResponse) SDKResponseMetdata added in v0.9.0 

func (r *ImportCertificateAuthorityCertificateResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ImportCertificateAuthorityCertificate request.

type IssueCertificateInput 

type IssueCertificateInput struct {

	// The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority.
	// This must be of the form:
	//
	// arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
	//
	// CertificateAuthorityArn is a required field
	CertificateAuthorityArn *string `min:"5" type:"string" required:"true"`

	// The certificate signing request (CSR) for the certificate you want to issue.
	// You can use the following OpenSSL command to create the CSR and a 2048 bit
	// RSA private key.
	//
	// openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem
	// -out csr/test_cert_.csr
	//
	// If you have a configuration file, you can use the following OpenSSL command.
	// The usr_cert block in the configuration file contains your X509 version 3
	// extensions.
	//
	// openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048
	// -days -365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr
	//
	// Csr is automatically base64 encoded/decoded by the SDK.
	//
	// Csr is a required field
	Csr []byte `min:"1" type:"blob" required:"true"`

	// Custom string that can be used to distinguish between calls to the IssueCertificate
	// action. Idempotency tokens time out after one hour. Therefore, if you call
	// IssueCertificate multiple times with the same idempotency token within 5
	// minutes, ACM Private CA recognizes that you are requesting only one certificate
	// and will issue only one. If you change the idempotency token for each call,
	// PCA recognizes that you are requesting multiple certificates.
	IdempotencyToken *string `min:"1" type:"string"`

	// The name of the algorithm that will be used to sign the certificate to be
	// issued.
	//
	// SigningAlgorithm is a required field
	SigningAlgorithm SigningAlgorithm `type:"string" required:"true" enum:"true"`

	// Specifies a custom configuration template to use when issuing a certificate.
	// If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1
	// template.
	//
	// The following service-owned TemplateArn values are supported by ACM Private
	// CA:
	//
	//    * arn:aws:acm-pca:::template/EndEntityCertificate/V1
	//
	//    * arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen0/V1
	//
	//    * arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen1/V1
	//
	//    * arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen2/V1
	//
	//    * arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen3/V1
	//
	//    * arn:aws:acm-pca:::template/RootCACertificate/V1
	//
	// For more information, see Using Templates (https://docs.aws.amazon.com/acm-pca/latest/userguide/UsingTemplates.html).
	TemplateArn *string `min:"5" type:"string"`

	// The type of the validity period.
	//
	// Validity is a required field
	Validity *Validity `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (IssueCertificateInput) String 

func (s IssueCertificateInput) String() string

String returns the string representation

func (*IssueCertificateInput) Validate 

func (s *IssueCertificateInput) Validate() error

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

type IssueCertificateOutput 

type IssueCertificateOutput struct {

	// The Amazon Resource Name (ARN) of the issued certificate and the certificate
	// serial number. This is of the form:
	//
	// arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245
	CertificateArn *string `min:"5" type:"string"`
	// contains filtered or unexported fields
}

func (IssueCertificateOutput) String 

func (s IssueCertificateOutput) String() string

String returns the string representation

type IssueCertificateRequest 

type IssueCertificateRequest struct {
	*aws.Request
	Input *IssueCertificateInput
	Copy  func(*IssueCertificateInput) IssueCertificateRequest
}

IssueCertificateRequest is the request type for the IssueCertificate API operation.

func (IssueCertificateRequest) Send 

func (r IssueCertificateRequest) Send(ctx context.Context) (*IssueCertificateResponse, error)

Send marshals and sends the IssueCertificate API request.

type IssueCertificateResponse added in v0.9.0 

type IssueCertificateResponse struct {
	*IssueCertificateOutput
	// contains filtered or unexported fields
}

IssueCertificateResponse is the response type for the IssueCertificate API operation.

func (*IssueCertificateResponse) SDKResponseMetdata added in v0.9.0 

func (r *IssueCertificateResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the IssueCertificate request.

type KeyAlgorithm 

type KeyAlgorithm string
const (
	KeyAlgorithmRsa2048      KeyAlgorithm = "RSA_2048"
	KeyAlgorithmRsa4096      KeyAlgorithm = "RSA_4096"
	KeyAlgorithmEcPrime256v1 KeyAlgorithm = "EC_prime256v1"
	KeyAlgorithmEcSecp384r1  KeyAlgorithm = "EC_secp384r1"
)

Enum values for KeyAlgorithm

func (KeyAlgorithm) MarshalValue 

func (enum KeyAlgorithm) MarshalValue() (string, error)

func (KeyAlgorithm) MarshalValueBuf 

func (enum KeyAlgorithm) MarshalValueBuf(b []byte) ([]byte, error)

type ListCertificateAuthoritiesInput 

type ListCertificateAuthoritiesInput struct {

	// Use this parameter when paginating results to specify the maximum number
	// of items to return in the response on each page. 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.
	MaxResults *int64 `min:"1" type:"integer"`

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

func (ListCertificateAuthoritiesInput) String 

func (s ListCertificateAuthoritiesInput) String() string

String returns the string representation

func (*ListCertificateAuthoritiesInput) Validate 

func (s *ListCertificateAuthoritiesInput) Validate() error

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

type ListCertificateAuthoritiesOutput 

type ListCertificateAuthoritiesOutput struct {

	// Summary information about each certificate authority you have created.
	CertificateAuthorities []CertificateAuthority `type:"list"`

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

func (ListCertificateAuthoritiesOutput) String 

func (s ListCertificateAuthoritiesOutput) String() string

String returns the string representation

type ListCertificateAuthoritiesPaginator added in v0.9.0 

type ListCertificateAuthoritiesPaginator struct {
	aws.Pager
}

ListCertificateAuthoritiesPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListCertificateAuthoritiesPaginator added in v0.9.0 

func NewListCertificateAuthoritiesPaginator(req ListCertificateAuthoritiesRequest) ListCertificateAuthoritiesPaginator

NewListCertificateAuthoritiesRequestPaginator returns a paginator for ListCertificateAuthorities. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListCertificateAuthoritiesRequest(input)
p := acmpca.NewListCertificateAuthoritiesRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListCertificateAuthoritiesPaginator) CurrentPage added in v0.9.0 

func (p *ListCertificateAuthoritiesPaginator) CurrentPage() *ListCertificateAuthoritiesOutput

type ListCertificateAuthoritiesRequest 

type ListCertificateAuthoritiesRequest struct {
	*aws.Request
	Input *ListCertificateAuthoritiesInput
	Copy  func(*ListCertificateAuthoritiesInput) ListCertificateAuthoritiesRequest
}

ListCertificateAuthoritiesRequest is the request type for the ListCertificateAuthorities API operation.

func (ListCertificateAuthoritiesRequest) Send 

func (r ListCertificateAuthoritiesRequest) Send(ctx context.Context) (*ListCertificateAuthoritiesResponse, error)

Send marshals and sends the ListCertificateAuthorities API request.

type ListCertificateAuthoritiesResponse added in v0.9.0 

type ListCertificateAuthoritiesResponse struct {
	*ListCertificateAuthoritiesOutput
	// contains filtered or unexported fields
}

ListCertificateAuthoritiesResponse is the response type for the ListCertificateAuthorities API operation.

func (*ListCertificateAuthoritiesResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListCertificateAuthoritiesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListCertificateAuthorities request.

type ListPermissionsInput added in v0.8.0 

type ListPermissionsInput struct {

	// The Amazon Resource Number (ARN) of the private CA to inspect. You can find
	// the ARN by calling the ListCertificateAuthorities action. This must be of
	// the form: arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
	// You can get a private CA's ARN by running the ListCertificateAuthorities
	// action.
	//
	// CertificateAuthorityArn is a required field
	CertificateAuthorityArn *string `min:"5" type:"string" required:"true"`

	// When paginating results, use this parameter 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.
	MaxResults *int64 `min:"1" type:"integer"`

	// When paginating results, use this parameter 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 (ListPermissionsInput) String added in v0.8.0 

func (s ListPermissionsInput) String() string

String returns the string representation

func (*ListPermissionsInput) Validate added in v0.8.0 

func (s *ListPermissionsInput) Validate() error

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

type ListPermissionsOutput added in v0.8.0 

type ListPermissionsOutput struct {

	// When the list is truncated, this value is present and should be used for
	// the NextToken parameter in a subsequent pagination request.
	NextToken *string `min:"1" type:"string"`

	// Summary information about each permission assigned by the specified private
	// CA, including the action enabled, the policy provided, and the time of creation.
	Permissions []Permission `type:"list"`
	// contains filtered or unexported fields
}

func (ListPermissionsOutput) String added in v0.8.0 

func (s ListPermissionsOutput) String() string

String returns the string representation

type ListPermissionsPaginator added in v0.9.0 

type ListPermissionsPaginator struct {
	aws.Pager
}

ListPermissionsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListPermissionsPaginator added in v0.9.0 

func NewListPermissionsPaginator(req ListPermissionsRequest) ListPermissionsPaginator

NewListPermissionsRequestPaginator returns a paginator for ListPermissions. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListPermissionsRequest(input)
p := acmpca.NewListPermissionsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListPermissionsPaginator) CurrentPage added in v0.9.0 

func (p *ListPermissionsPaginator) CurrentPage() *ListPermissionsOutput

type ListPermissionsRequest added in v0.8.0 

type ListPermissionsRequest struct {
	*aws.Request
	Input *ListPermissionsInput
	Copy  func(*ListPermissionsInput) ListPermissionsRequest
}

ListPermissionsRequest is the request type for the ListPermissions API operation.

func (ListPermissionsRequest) Send added in v0.8.0 

func (r ListPermissionsRequest) Send(ctx context.Context) (*ListPermissionsResponse, error)

Send marshals and sends the ListPermissions API request.

type ListPermissionsResponse added in v0.9.0 

type ListPermissionsResponse struct {
	*ListPermissionsOutput
	// contains filtered or unexported fields
}

ListPermissionsResponse is the response type for the ListPermissions API operation.

func (*ListPermissionsResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListPermissionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListPermissions request.

type ListTagsInput 

type ListTagsInput struct {

	// The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority
	// action. This must be of the form:
	//
	// arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
	//
	// CertificateAuthorityArn is a required field
	CertificateAuthorityArn *string `min:"5" type:"string" required:"true"`

	// 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.
	MaxResults *int64 `min:"1" type:"integer"`

	// Use this parameter when paginating results 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 (ListTagsInput) String 

func (s ListTagsInput) String() string

String returns the string representation

func (*ListTagsInput) Validate 

func (s *ListTagsInput) Validate() error

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

type ListTagsOutput 

type ListTagsOutput struct {

	// When the list is truncated, this value is present and should be used for
	// the NextToken parameter in a subsequent pagination request.
	NextToken *string `min:"1" type:"string"`

	// The tags associated with your private CA.
	Tags []Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsOutput) String 

func (s ListTagsOutput) String() string

String returns the string representation

type ListTagsPaginator added in v0.9.0 

type ListTagsPaginator struct {
	aws.Pager
}

ListTagsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListTagsPaginator added in v0.9.0 

func NewListTagsPaginator(req ListTagsRequest) ListTagsPaginator

NewListTagsRequestPaginator returns a paginator for ListTags. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListTagsRequest(input)
p := acmpca.NewListTagsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListTagsPaginator) CurrentPage added in v0.9.0 

func (p *ListTagsPaginator) CurrentPage() *ListTagsOutput

type ListTagsRequest 

type ListTagsRequest struct {
	*aws.Request
	Input *ListTagsInput
	Copy  func(*ListTagsInput) ListTagsRequest
}

ListTagsRequest is the request type for the ListTags API operation.

func (ListTagsRequest) Send 

func (r ListTagsRequest) Send(ctx context.Context) (*ListTagsResponse, error)

Send marshals and sends the ListTags API request.

type ListTagsResponse added in v0.9.0 

type ListTagsResponse struct {
	*ListTagsOutput
	// contains filtered or unexported fields
}

ListTagsResponse is the response type for the ListTags API operation.

func (*ListTagsResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListTagsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTags request.

type Permission added in v0.8.0 

type Permission struct {

	// The private CA actions that can be performed by the designated AWS service.
	Actions []ActionType `min:"1" type:"list"`

	// The Amazon Resource Number (ARN) of the private CA from which the permission
	// was issued.
	CertificateAuthorityArn *string `min:"5" type:"string"`

	// The time at which the permission was created.
	CreatedAt *time.Time `type:"timestamp"`

	// The name of the policy that is associated with the permission.
	Policy *string `type:"string"`

	// The AWS service or entity that holds the permission. At this time, the only
	// valid principal is acm.amazonaws.com.
	Principal *string `type:"string"`

	// The ID of the account that assigned the permission.
	SourceAccount *string `type:"string"`
	// contains filtered or unexported fields
}

Permissions designate which private CA actions can be performed by an AWS service or entity. In order for ACM to automatically renew private certificates, you must give the ACM service principal all available permissions (IssueCertificate, GetCertificate, and ListPermissions). Permissions can be assigned with the CreatePermission action, removed with the DeletePermission action, and listed with the ListPermissions action.

func (Permission) String added in v0.8.0 

func (s Permission) String() string

String returns the string representation

type RestoreCertificateAuthorityInput added in v0.5.0 

type RestoreCertificateAuthorityInput struct {

	// The Amazon Resource Name (ARN) that was returned when you called the CreateCertificateAuthority
	// action. This must be of the form:
	//
	// arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
	//
	// CertificateAuthorityArn is a required field
	CertificateAuthorityArn *string `min:"5" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RestoreCertificateAuthorityInput) String added in v0.5.0 

func (s RestoreCertificateAuthorityInput) String() string

String returns the string representation

func (*RestoreCertificateAuthorityInput) Validate added in v0.5.0 

func (s *RestoreCertificateAuthorityInput) Validate() error

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

type RestoreCertificateAuthorityOutput added in v0.5.0 

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

func (RestoreCertificateAuthorityOutput) String added in v0.5.0 

func (s RestoreCertificateAuthorityOutput) String() string

String returns the string representation

type RestoreCertificateAuthorityRequest added in v0.5.0 

type RestoreCertificateAuthorityRequest struct {
	*aws.Request
	Input *RestoreCertificateAuthorityInput
	Copy  func(*RestoreCertificateAuthorityInput) RestoreCertificateAuthorityRequest
}

RestoreCertificateAuthorityRequest is the request type for the RestoreCertificateAuthority API operation.

func (RestoreCertificateAuthorityRequest) Send added in v0.5.0 

func (r RestoreCertificateAuthorityRequest) Send(ctx context.Context) (*RestoreCertificateAuthorityResponse, error)

Send marshals and sends the RestoreCertificateAuthority API request.

type RestoreCertificateAuthorityResponse added in v0.9.0 

type RestoreCertificateAuthorityResponse struct {
	*RestoreCertificateAuthorityOutput
	// contains filtered or unexported fields
}

RestoreCertificateAuthorityResponse is the response type for the RestoreCertificateAuthority API operation.

func (*RestoreCertificateAuthorityResponse) SDKResponseMetdata added in v0.9.0 

func (r *RestoreCertificateAuthorityResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the RestoreCertificateAuthority request.

type RevocationConfiguration 

type RevocationConfiguration struct {

	// Configuration of the certificate revocation list (CRL), if any, maintained
	// by your private CA.
	CrlConfiguration *CrlConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions. Your private certificate authority (CA) can create and maintain a certificate revocation list (CRL). A CRL contains information about certificates revoked by your CA. For more information, see RevokeCertificate.

func (RevocationConfiguration) String 

func (s RevocationConfiguration) String() string

String returns the string representation

func (*RevocationConfiguration) Validate 

func (s *RevocationConfiguration) Validate() error

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

type RevocationReason 

type RevocationReason string
const (
	RevocationReasonUnspecified                    RevocationReason = "UNSPECIFIED"
	RevocationReasonKeyCompromise                  RevocationReason = "KEY_COMPROMISE"
	RevocationReasonCertificateAuthorityCompromise RevocationReason = "CERTIFICATE_AUTHORITY_COMPROMISE"
	RevocationReasonAffiliationChanged             RevocationReason = "AFFILIATION_CHANGED"
	RevocationReasonSuperseded                     RevocationReason = "SUPERSEDED"
	RevocationReasonCessationOfOperation           RevocationReason = "CESSATION_OF_OPERATION"
	RevocationReasonPrivilegeWithdrawn             RevocationReason = "PRIVILEGE_WITHDRAWN"
	RevocationReasonAACompromise                   RevocationReason = "A_A_COMPROMISE"
)

Enum values for RevocationReason

func (RevocationReason) MarshalValue 

func (enum RevocationReason) MarshalValue() (string, error)

func (RevocationReason) MarshalValueBuf 

func (enum RevocationReason) MarshalValueBuf(b []byte) ([]byte, error)

type RevokeCertificateInput 

type RevokeCertificateInput struct {

	// Amazon Resource Name (ARN) of the private CA that issued the certificate
	// to be revoked. This must be of the form:
	//
	// arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
	//
	// CertificateAuthorityArn is a required field
	CertificateAuthorityArn *string `min:"5" type:"string" required:"true"`

	// Serial number of the certificate to be revoked. This must be in hexadecimal
	// format. You can retrieve the serial number by calling GetCertificate with
	// the Amazon Resource Name (ARN) of the certificate you want and the ARN of
	// your private CA. The GetCertificate action retrieves the certificate in the
	// PEM format. You can use the following OpenSSL command to list the certificate
	// in text format and copy the hexadecimal serial number.
	//
	// openssl x509 -in file_path -text -noout
	//
	// You can also copy the serial number from the console or use the DescribeCertificate
	// (https://docs.aws.amazon.com/acm/latest/APIReference/API_DescribeCertificate.html)
	// action in the AWS Certificate Manager API Reference.
	//
	// CertificateSerial is a required field
	CertificateSerial *string `type:"string" required:"true"`

	// Specifies why you revoked the certificate.
	//
	// RevocationReason is a required field
	RevocationReason RevocationReason `type:"string" required:"true" enum:"true"`
	// contains filtered or unexported fields
}

func (RevokeCertificateInput) String 

func (s RevokeCertificateInput) String() string

String returns the string representation

func (*RevokeCertificateInput) Validate 

func (s *RevokeCertificateInput) Validate() error

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

type RevokeCertificateOutput 

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

func (RevokeCertificateOutput) String 

func (s RevokeCertificateOutput) String() string

String returns the string representation

type RevokeCertificateRequest 

type RevokeCertificateRequest struct {
	*aws.Request
	Input *RevokeCertificateInput
	Copy  func(*RevokeCertificateInput) RevokeCertificateRequest
}

RevokeCertificateRequest is the request type for the RevokeCertificate API operation.

func (RevokeCertificateRequest) Send 

func (r RevokeCertificateRequest) Send(ctx context.Context) (*RevokeCertificateResponse, error)

Send marshals and sends the RevokeCertificate API request.

type RevokeCertificateResponse added in v0.9.0 

type RevokeCertificateResponse struct {
	*RevokeCertificateOutput
	// contains filtered or unexported fields
}

RevokeCertificateResponse is the response type for the RevokeCertificate API operation.

func (*RevokeCertificateResponse) SDKResponseMetdata added in v0.9.0 

func (r *RevokeCertificateResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the RevokeCertificate request.

type SigningAlgorithm 

type SigningAlgorithm string
const (
	SigningAlgorithmSha256withecdsa SigningAlgorithm = "SHA256WITHECDSA"
	SigningAlgorithmSha384withecdsa SigningAlgorithm = "SHA384WITHECDSA"
	SigningAlgorithmSha512withecdsa SigningAlgorithm = "SHA512WITHECDSA"
	SigningAlgorithmSha256withrsa   SigningAlgorithm = "SHA256WITHRSA"
	SigningAlgorithmSha384withrsa   SigningAlgorithm = "SHA384WITHRSA"
	SigningAlgorithmSha512withrsa   SigningAlgorithm = "SHA512WITHRSA"
)

Enum values for SigningAlgorithm

func (SigningAlgorithm) MarshalValue 

func (enum SigningAlgorithm) MarshalValue() (string, error)

func (SigningAlgorithm) MarshalValueBuf 

func (enum SigningAlgorithm) MarshalValueBuf(b []byte) ([]byte, error)

type Tag 

type Tag struct {

	// Key (name) of the tag.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

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

Tags are labels that you can use to identify and organize your private CAs. Each tag consists of a key and an optional value. You can associate up to 50 tags with a private CA. To add one or more tags to a private CA, call the TagCertificateAuthority action. To remove a tag, call the UntagCertificateAuthority action.

func (Tag) String 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate 

func (s *Tag) Validate() error

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

type TagCertificateAuthorityInput 

type TagCertificateAuthorityInput struct {

	// The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority.
	// This must be of the form:
	//
	// arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
	//
	// CertificateAuthorityArn is a required field
	CertificateAuthorityArn *string `min:"5" type:"string" required:"true"`

	// List of tags to be associated with the CA.
	//
	// Tags is a required field
	Tags []Tag `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagCertificateAuthorityInput) String 

func (s TagCertificateAuthorityInput) String() string

String returns the string representation

func (*TagCertificateAuthorityInput) Validate 

func (s *TagCertificateAuthorityInput) Validate() error

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

type TagCertificateAuthorityOutput 

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

func (TagCertificateAuthorityOutput) String 

func (s TagCertificateAuthorityOutput) String() string

String returns the string representation

type TagCertificateAuthorityRequest 

type TagCertificateAuthorityRequest struct {
	*aws.Request
	Input *TagCertificateAuthorityInput
	Copy  func(*TagCertificateAuthorityInput) TagCertificateAuthorityRequest
}

TagCertificateAuthorityRequest is the request type for the TagCertificateAuthority API operation.

func (TagCertificateAuthorityRequest) Send 

func (r TagCertificateAuthorityRequest) Send(ctx context.Context) (*TagCertificateAuthorityResponse, error)

Send marshals and sends the TagCertificateAuthority API request.

type TagCertificateAuthorityResponse added in v0.9.0 

type TagCertificateAuthorityResponse struct {
	*TagCertificateAuthorityOutput
	// contains filtered or unexported fields
}

TagCertificateAuthorityResponse is the response type for the TagCertificateAuthority API operation.

func (*TagCertificateAuthorityResponse) SDKResponseMetdata added in v0.9.0 

func (r *TagCertificateAuthorityResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TagCertificateAuthority request.

type UntagCertificateAuthorityInput 

type UntagCertificateAuthorityInput struct {

	// The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority.
	// This must be of the form:
	//
	// arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
	//
	// CertificateAuthorityArn is a required field
	CertificateAuthorityArn *string `min:"5" type:"string" required:"true"`

	// List of tags to be removed from the CA.
	//
	// Tags is a required field
	Tags []Tag `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagCertificateAuthorityInput) String 

func (s UntagCertificateAuthorityInput) String() string

String returns the string representation

func (*UntagCertificateAuthorityInput) Validate 

func (s *UntagCertificateAuthorityInput) Validate() error

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

type UntagCertificateAuthorityOutput 

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

func (UntagCertificateAuthorityOutput) String 

func (s UntagCertificateAuthorityOutput) String() string

String returns the string representation

type UntagCertificateAuthorityRequest 

type UntagCertificateAuthorityRequest struct {
	*aws.Request
	Input *UntagCertificateAuthorityInput
	Copy  func(*UntagCertificateAuthorityInput) UntagCertificateAuthorityRequest
}

UntagCertificateAuthorityRequest is the request type for the UntagCertificateAuthority API operation.

func (UntagCertificateAuthorityRequest) Send 

func (r UntagCertificateAuthorityRequest) Send(ctx context.Context) (*UntagCertificateAuthorityResponse, error)

Send marshals and sends the UntagCertificateAuthority API request.

type UntagCertificateAuthorityResponse added in v0.9.0 

type UntagCertificateAuthorityResponse struct {
	*UntagCertificateAuthorityOutput
	// contains filtered or unexported fields
}

UntagCertificateAuthorityResponse is the response type for the UntagCertificateAuthority API operation.

func (*UntagCertificateAuthorityResponse) SDKResponseMetdata added in v0.9.0 

func (r *UntagCertificateAuthorityResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UntagCertificateAuthority request.

type UpdateCertificateAuthorityInput 

type UpdateCertificateAuthorityInput struct {

	// Amazon Resource Name (ARN) of the private CA that issued the certificate
	// to be revoked. This must be of the form:
	//
	// arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
	//
	// CertificateAuthorityArn is a required field
	CertificateAuthorityArn *string `min:"5" type:"string" required:"true"`

	// Revocation information for your private CA.
	RevocationConfiguration *RevocationConfiguration `type:"structure"`

	// Status of your private CA.
	Status CertificateAuthorityStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

func (UpdateCertificateAuthorityInput) String 

func (s UpdateCertificateAuthorityInput) String() string

String returns the string representation

func (*UpdateCertificateAuthorityInput) Validate 

func (s *UpdateCertificateAuthorityInput) Validate() error

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

type UpdateCertificateAuthorityOutput 

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

func (UpdateCertificateAuthorityOutput) String 

func (s UpdateCertificateAuthorityOutput) String() string

String returns the string representation

type UpdateCertificateAuthorityRequest 

type UpdateCertificateAuthorityRequest struct {
	*aws.Request
	Input *UpdateCertificateAuthorityInput
	Copy  func(*UpdateCertificateAuthorityInput) UpdateCertificateAuthorityRequest
}

UpdateCertificateAuthorityRequest is the request type for the UpdateCertificateAuthority API operation.

func (UpdateCertificateAuthorityRequest) Send 

func (r UpdateCertificateAuthorityRequest) Send(ctx context.Context) (*UpdateCertificateAuthorityResponse, error)

Send marshals and sends the UpdateCertificateAuthority API request.

type UpdateCertificateAuthorityResponse added in v0.9.0 

type UpdateCertificateAuthorityResponse struct {
	*UpdateCertificateAuthorityOutput
	// contains filtered or unexported fields
}

UpdateCertificateAuthorityResponse is the response type for the UpdateCertificateAuthority API operation.

func (*UpdateCertificateAuthorityResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateCertificateAuthorityResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateCertificateAuthority request.

type Validity 

type Validity struct {

	// Specifies whether the Value parameter represents days, months, or years.
	//
	// Type is a required field
	Type ValidityPeriodType `type:"string" required:"true" enum:"true"`

	// Time period.
	//
	// Value is a required field
	Value *int64 `min:"1" type:"long" required:"true"`
	// contains filtered or unexported fields
}

Length of time for which the certificate issued by your private certificate authority (CA), or by the private CA itself, is valid in days, months, or years. You can issue a certificate by calling the IssueCertificate action.

func (Validity) String 

func (s Validity) String() string

String returns the string representation

func (*Validity) Validate 

func (s *Validity) Validate() error

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

type ValidityPeriodType 

type ValidityPeriodType string
const (
	ValidityPeriodTypeEndDate  ValidityPeriodType = "END_DATE"
	ValidityPeriodTypeAbsolute ValidityPeriodType = "ABSOLUTE"
	ValidityPeriodTypeDays     ValidityPeriodType = "DAYS"
	ValidityPeriodTypeMonths   ValidityPeriodType = "MONTHS"
	ValidityPeriodTypeYears    ValidityPeriodType = "YEARS"
)

Enum values for ValidityPeriodType

func (ValidityPeriodType) MarshalValue 

func (enum ValidityPeriodType) MarshalValue() (string, error)

func (ValidityPeriodType) MarshalValueBuf 

func (enum ValidityPeriodType) MarshalValueBuf(b []byte) ([]byte, error)

Source Files

View all Source files

Directories

Path Synopsis
Package acmpcaiface provides an interface to enable mocking the AWS Certificate Manager Private Certificate Authority service client for testing your code.
 Package acmpcaiface provides an interface to enable mocking the AWS Certificate Manager Private Certificate Authority service client for testing your code.

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.