AwsAcm

Service-level AWS ACM component for DNS-validated certificates.

Remarks

This component requests one ACM certificate, resolves Route53 hosted zones for the primary domain and each SAN, creates DNS validation records for those domains, and waits for validation completion via aws.acm.CertificateValidation.

Naming:

• Root: type token ${namespace}:aws:AwsAcm; capability acm; identity args.domainName; target ${env}-${projectHash}-acm-${sanitiseNamePart(identity)}.
• aws:acm/certificate:Certificate child: parent AwsAcm; readable tuple [args.domainName]; target ${env}-${projectHash}-${sanitiseNamePart(identity)}.
• aws:route53/record:Record child: parent AwsAcm; readable tuple [args.domainName, validationPlan.plannedValidationRecords[validationRecordKey].validationRecordKey]; target ${env}-${projectHash}-${sanitiseNamePart(identity)}-${sanitiseNamePart(validationRecordKey)}.
• aws:acm/certificateValidation:CertificateValidation child: parent AwsAcm; readable tuple [args.domainName]; target ${env}-${projectHash}-${sanitiseNamePart(identity)}.
• AWS provider names: ACM certificate domainName is a semantic/external identifier sourced from args.domainName, trimmed, lowercased, and stripped of trailing dots before forwarding. The component validates a synchronous non-empty domain with no empty labels and wildcard placement; ACM owns complete domain syntax and length validation. ACM exposes no settable certificate name. Route53 record name is the ACM-issued semantic domainValidationOptions[*].resourceRecordName, forwarded unchanged; ACM owns its DNS-record constraints. CertificateValidation has no provider name. The AWS six-style standard does not apply.

Example

const certificate = new AwsAcm({
  domainName: 'api.orders.example.com',
  subjectAlternativeNames: ['orders.example.com'],
});

Constructors

new AwsAcm( args: AwsAcmArgs, options?: ComponentResourceOptions, ): AwsAcm

Parameters

• args (AwsAcmArgs) — Certificate request and DNS validation orchestration inputs. Use new AwsAcm(args, options).The component logical name is derived using the canonical ${env}-${projectHash}-acm-<identity> pattern, where <identity> is the sanitised deterministic normalisation of args.domainName.
• options (ComponentResourceOptions, optional) — Optional settings controlling resource behaviour.

Returns

AwsAcm

Hierarchy

• ComponentResource
• AwsAcm

Properties

certificate: Certificate

Requested ACM certificate resource.

certificateArn: Output<string>

ARN of the validated certificate.

certificateValidation: CertificateValidation

ACM certificate validation waiter resource.

domainValidationOptions: Output<CertificateDomainValidationOption[]>

Domain validation options emitted by ACM for DNS validation.

urn: Output<string>

Inherited from urn

The stable logical URN used to distinctly address a resource, both before and after deployments.

validationRecords: Output<Record[]>

Route53 DNS validation records created by this component.

Methods

getData(): Promise<any>

Inherited from getData

Retrieves the data produces by initialize. The data is immediately available in a derived class's constructor after the super(...) call to ComponentResource.

Returns

• Promise<any>

getProvider(moduleMember: string): ProviderResource | undefined

Inherited from getProvider

Returns the provider for the given module member, if one exists.

Parameters

• moduleMember (string)

Returns

• ProviderResource | undefined

initialize( args: Inputs, opts?: ComponentResourceOptions, name?: string, type?: string, ): Promise<any>

Inherited from initialize

Can be overridden by a subclass to asynchronously initialize data for this component automatically when constructed. The data will be available immediately for subclass constructors to use. To access the data use getData.

Parameters

• args (Inputs)
• opts (ComponentResourceOptions, optional)
• name (string, optional)
• type (string, optional)

Returns

• Promise<any>

registerOutputs( outputs?: Inputs | Promise<Inputs> | Output<Inputs>, ): void

Inherited from registerOutputs

Registers synthetic outputs that a component has initialized, usually by allocating other child sub-resources and propagating their resulting property values.

Component resources can call this at the end of their constructor to indicate that they are done creating child resources. This is not strictly necessary as this will automatically be called after the initialize method completes.

Parameters

• outputs (Inputs | Promise<Inputs> | Output<Inputs>, optional)

Returns

• void

Static Methods

isInstance(obj: any): obj is ComponentResource<any>

Inherited from isInstance

Returns true if the given object is a CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

Parameters

• obj (any)

Returns

• obj is ComponentResource<any>