AwsSsmParameter

Service-level AWS SSM parameter component.

Remarks

Naming:

Root: ${env}-${projectHash}-parameter-${sanitiseNamePart(args.parameter.name)}; type ${namespace}:aws:AwsSsmParameter; identity args.parameter.name is shared with the provider name.
aws:ssm/parameter:Parameter has parent AwsSsmParameter, qualified type aws:ssm/parameter:Parameter, and tuple [args.parameter.name]; its logical name is ${env}-${projectHash}-${sanitiseNamePart(args.parameter.name)}. The optional pulumi:providers:aws assume-role child uses the same tuple. When configured, a nested ${namespace}:aws:AwsRam component, parented by AwsSsmParameter, uses resource-association and args.parameter.name as its identity, yielding ${env}-${projectHash}-resource-association-${sanitised args.parameter.name}. Its aws:ram/resourceAssociation:ResourceAssociation child uses tuple [args.parameter.name].
Parameter name uses stackAndPurpose, built with buildAwsNameFromCamelCasePurpose('stackAndPurpose', ...), from args.parameter.name and resolves to ${env}-${projectHash}-${purpose}. SSM parameter names permit 1,011 characters, so no local purpose maximum applies. KMS keyId is an external KMS ARN and is omitted for plaintext parameters; the RAM resource-share name or typed reference is forwarded unchanged to the nested AwsRam component.

Example

CODE

import { AwsSsmParameter } from '@jobcloud/aws-ssm-parameter';

const parameter = new AwsSsmParameter({
  parameter: { name: 'dbPassword', value: 'secret', kmsKey: { identifier: 'alias/platform-ssm' } },
});

Constructors

`new AwsSsmParameter( args: AwsSsmParameterArgs, options?: ComponentResourceOptions, ): AwsSsmParameter`

Parameters

args (AwsSsmParameterArgs)
options (ComponentResourceOptions, optional)

Returns

AwsSsmParameter

Hierarchy

ComponentResource
AwsSsmParameter

Properties

`arn: Output<string>`

readonly

The ARN of the created parameter.

`kmsKeyArn: Output<string> | undefined`

readonly

The resolved KMS key ARN when args.parameter.kmsKey is supplied.

`parameter: Parameter`

readonly

The created SSM parameter resource.

`parameterArgs: AwsSsmParameterParameterArgs`

readonly

Input used to create the parameter.

`parameterName: Output<string>`

readonly

The created SSM parameter name.

`ramResourceAssociation: ResourceAssociation | undefined`

readonly

Optional RAM resource association.

`ramResourceShareArn: Output<string> | undefined`

readonly

The resolved RAM resource share ARN, when configured.

`urn: Output<string>`

readonly

Inherited from urn

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

`version: OutputInstance<number>`

readonly

The current parameter version.

Methods

`getData(): Promise<any>`

protectedasync

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>`

protectedasync

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`

protected

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>`

static

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>