acm

package
v1.13.0 Latest Latest
Warning

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

 Go to latest Published: Dec 2, 2019 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Certificate 

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

The ACM certificate resource allows requesting and management of certificates from the Amazon Certificate Manager.

It deals with requesting certificates and managing their attributes and life-cycle. This resource does not deal with validation of a certificate but can provide inputs for other resources implementing the validation. It does not wait for a certificate to be issued. Use a `acm.CertificateValidation` resource for this.

Most commonly, this resource is used to together with `route53.Record` and `acm.CertificateValidation` to request a DNS validated certificate, deploy the required validation records and wait for validation to complete.

Domain validation through E-Mail is also supported but should be avoided as it requires a manual step outside of this provider.

It's recommended to specify `createBeforeDestroy = true` in a [lifecycle][1] block to replace a certificate which is currently in use (eg, by `lb.Listener`).

## options Configuration Block

Supported nested arguments for the `options` configuration block:

* `certificateTransparencyLoggingPreference` - (Optional) Specifies whether certificate details should be added to a certificate transparency log. Valid values are `ENABLED` or `DISABLED`. See https://docs.aws.amazon.com/acm/latest/userguide/acm-concepts.html#concept-transparency for more details.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/acm_certificate.html.markdown.

func GetCertificate 

func GetCertificate(ctx *pulumi.Context,
	name string, id pulumi.ID, state *CertificateState, opts ...pulumi.ResourceOpt) (*Certificate, error)

GetCertificate gets an existing Certificate resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewCertificate 

func NewCertificate(ctx *pulumi.Context,
	name string, args *CertificateArgs, opts ...pulumi.ResourceOpt) (*Certificate, error)

NewCertificate registers a new resource with the given unique name, arguments, and options.

func (*Certificate) Arn 

func (r *Certificate) Arn() pulumi.StringOutput

The ARN of the certificate

func (*Certificate) CertificateAuthorityArn added in v0.18.27 

func (r *Certificate) CertificateAuthorityArn() pulumi.StringOutput

ARN of an ACMPCA

func (*Certificate) CertificateBody added in v0.16.5 

func (r *Certificate) CertificateBody() pulumi.StringOutput

The certificate's PEM-formatted public key

func (*Certificate) CertificateChain added in v0.16.5 

func (r *Certificate) CertificateChain() pulumi.StringOutput

The certificate's PEM-formatted chain * Creating a private CA issued certificate

func (*Certificate) DomainName 

func (r *Certificate) DomainName() pulumi.StringOutput

A domain name for which the certificate should be issued

func (*Certificate) DomainValidationOptions 

func (r *Certificate) DomainValidationOptions() pulumi.ArrayOutput

A list of attributes to feed into other resources to complete certificate validation. Can have more than one element, e.g. if SANs are defined. Only set if `DNS`-validation was used.

func (*Certificate) ID 

func (r *Certificate) ID() pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Certificate) Options added in v0.18.27 

func (r *Certificate) Options() pulumi.Output

func (*Certificate) PrivateKey added in v0.16.5 

func (r *Certificate) PrivateKey() pulumi.StringOutput

The certificate's PEM-formatted private key

func (*Certificate) SubjectAlternativeNames 

func (r *Certificate) SubjectAlternativeNames() pulumi.ArrayOutput

A list of domains that should be SANs in the issued certificate

func (*Certificate) Tags 

func (r *Certificate) Tags() pulumi.MapOutput

A mapping of tags to assign to the resource.

func (*Certificate) URN 

func (r *Certificate) URN() pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*Certificate) ValidationEmails 

func (r *Certificate) ValidationEmails() pulumi.ArrayOutput

A list of addresses that received a validation E-Mail. Only set if `EMAIL`-validation was used.

func (*Certificate) ValidationMethod 

func (r *Certificate) ValidationMethod() pulumi.StringOutput

Which method to use for validation. `DNS` or `EMAIL` are valid, `NONE` can be used for certificates that were imported into ACM and then into state managed by this provider. * Importing an existing certificate

type CertificateArgs 

type CertificateArgs struct {
	// ARN of an ACMPCA
	CertificateAuthorityArn interface{}
	// The certificate's PEM-formatted public key
	CertificateBody interface{}
	// The certificate's PEM-formatted chain
	// * Creating a private CA issued certificate
	CertificateChain interface{}
	// A domain name for which the certificate should be issued
	DomainName interface{}
	Options    interface{}
	// The certificate's PEM-formatted private key
	PrivateKey interface{}
	// A list of domains that should be SANs in the issued certificate
	SubjectAlternativeNames interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
	// Which method to use for validation. `DNS` or `EMAIL` are valid, `NONE` can be used for certificates that were imported into ACM and then into state managed by this provider.
	// * Importing an existing certificate
	ValidationMethod interface{}
}

The set of arguments for constructing a Certificate resource.

type CertificateState 

type CertificateState struct {
	// The ARN of the certificate
	Arn interface{}
	// ARN of an ACMPCA
	CertificateAuthorityArn interface{}
	// The certificate's PEM-formatted public key
	CertificateBody interface{}
	// The certificate's PEM-formatted chain
	// * Creating a private CA issued certificate
	CertificateChain interface{}
	// A domain name for which the certificate should be issued
	DomainName interface{}
	// A list of attributes to feed into other resources to complete certificate validation. Can have more than one element, e.g. if SANs are defined. Only set if `DNS`-validation was used.
	DomainValidationOptions interface{}
	Options                 interface{}
	// The certificate's PEM-formatted private key
	PrivateKey interface{}
	// A list of domains that should be SANs in the issued certificate
	SubjectAlternativeNames interface{}
	// A mapping of tags to assign to the resource.
	Tags interface{}
	// A list of addresses that received a validation E-Mail. Only set if `EMAIL`-validation was used.
	ValidationEmails interface{}
	// Which method to use for validation. `DNS` or `EMAIL` are valid, `NONE` can be used for certificates that were imported into ACM and then into state managed by this provider.
	// * Importing an existing certificate
	ValidationMethod interface{}
}

Input properties used for looking up and filtering Certificate resources.

type CertificateValidation 

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

This resource represents a successful validation of an ACM certificate in concert with other resources.

Most commonly, this resource is used together with `route53.Record` and `acm.Certificate` to request a DNS validated certificate, deploy the required validation records and wait for validation to complete.

> **WARNING:** This resource implements a part of the validation workflow. It does not represent a real-world entity in AWS, therefore changing or deleting this resource on its own has no immediate effect.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/acm_certificate_validation.html.markdown.

func GetCertificateValidation 

func GetCertificateValidation(ctx *pulumi.Context,
	name string, id pulumi.ID, state *CertificateValidationState, opts ...pulumi.ResourceOpt) (*CertificateValidation, error)

GetCertificateValidation gets an existing CertificateValidation resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewCertificateValidation 

func NewCertificateValidation(ctx *pulumi.Context,
	name string, args *CertificateValidationArgs, opts ...pulumi.ResourceOpt) (*CertificateValidation, error)

NewCertificateValidation registers a new resource with the given unique name, arguments, and options.

func (*CertificateValidation) CertificateArn 

func (r *CertificateValidation) CertificateArn() pulumi.StringOutput

The ARN of the certificate that is being validated.

func (*CertificateValidation) ID 

func (r *CertificateValidation) ID() pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*CertificateValidation) URN 

func (r *CertificateValidation) URN() pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*CertificateValidation) ValidationRecordFqdns 

func (r *CertificateValidation) ValidationRecordFqdns() pulumi.ArrayOutput

List of FQDNs that implement the validation. Only valid for DNS validation method ACM certificates. If this is set, the resource can implement additional sanity checks and has an explicit dependency on the resource that is implementing the validation

type CertificateValidationArgs 

type CertificateValidationArgs struct {
	// The ARN of the certificate that is being validated.
	CertificateArn interface{}
	// List of FQDNs that implement the validation. Only valid for DNS validation method ACM certificates. If this is set, the resource can implement additional sanity checks and has an explicit dependency on the resource that is implementing the validation
	ValidationRecordFqdns interface{}
}

The set of arguments for constructing a CertificateValidation resource.

type CertificateValidationState 

type CertificateValidationState struct {
	// The ARN of the certificate that is being validated.
	CertificateArn interface{}
	// List of FQDNs that implement the validation. Only valid for DNS validation method ACM certificates. If this is set, the resource can implement additional sanity checks and has an explicit dependency on the resource that is implementing the validation
	ValidationRecordFqdns interface{}
}

Input properties used for looking up and filtering CertificateValidation resources.

type GetCertificateArgs 

type GetCertificateArgs struct {
	// The domain of the certificate to look up. If no certificate is found with this name, an error will be returned.
	Domain interface{}
	// A list of key algorithms to filter certificates. By default, ACM does not return all certificate types when searching. Valid values are `RSA_1024`, `RSA_2048`, `RSA_4096`, `EC_prime256v1`, `EC_secp384r1`, and `EC_secp521r1`.
	KeyTypes interface{}
	// If set to true, it sorts the certificates matched by previous criteria by the NotBefore field, returning only the most recent one. If set to false, it returns an error if more than one certificate is found. Defaults to false.
	MostRecent interface{}
	// A list of statuses on which to filter the returned list. Valid values are `PENDING_VALIDATION`, `ISSUED`,
	// `INACTIVE`, `EXPIRED`, `VALIDATION_TIMED_OUT`, `REVOKED` and `FAILED`. If no value is specified, only certificates in the `ISSUED` state
	// are returned.
	Statuses interface{}
	// A list of types on which to filter the returned list. Valid values are `AMAZON_ISSUED` and `IMPORTED`.
	Types interface{}
}

A collection of arguments for invoking getCertificate.

type GetCertificateResult 

type GetCertificateResult struct {
	// Set to the ARN of the found certificate, suitable for referencing in other resources that support ACM certificates.
	Arn        interface{}
	Domain     interface{}
	KeyTypes   interface{}
	MostRecent interface{}
	Statuses   interface{}
	Types      interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getCertificate.

func LookupCertificate 

func LookupCertificate(ctx *pulumi.Context, args *GetCertificateArgs) (*GetCertificateResult, error)

Use this data source to get the ARN of a certificate in AWS Certificate Manager (ACM), you can reference it by domain without having to hard code the ARNs as input.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/d/acm_certificate.html.markdown.

Source Files

View all Source files

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.