Skip to content

API.md

Latest commit

 

History

History
197 lines (120 loc) · 6.89 KB

API.md

File metadata and controls

197 lines (120 loc) · 6.89 KB

API Reference

Constructs

GlobalStringParameter

Creates an SSM Parameter in multiple regions using Custom Resources.

Initializers 

import { GlobalStringParameter } from 'cdk-global-parameter'

new GlobalStringParameter(scope: Construct, id: string, props: GlobalStringParameterProps)
Name Type Description
scope constructs.Construct No description.
id string No description.
props GlobalStringParameterProps No description.
scopeRequired
  • Type: constructs.Construct
idRequired
  • Type: string
propsRequired

Methods

Name Description
toString Returns a string representation of this construct.
toString 
public toString(): string

Returns a string representation of this construct.

Static Functions

Name Description
isConstruct Checks if x is a construct.
isConstruct 
import { GlobalStringParameter } from 'cdk-global-parameter'

GlobalStringParameter.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: any

Any object.

Properties

Name Type Description
node constructs.Node The tree node.
stringParameter aws-cdk-lib.aws_ssm.StringParameter No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

stringParameterRequired 
public readonly stringParameter: StringParameter;
  • Type: aws-cdk-lib.aws_ssm.StringParameter

Structs

GlobalStringParameterProps

GlobalStringParameterProps defines the properties for the GlobalStringParameter construct.

Initializer 

import { GlobalStringParameterProps } from 'cdk-global-parameter'

const globalStringParameterProps: GlobalStringParameterProps = { ... }

Properties

Name Type Description
parameterProps aws-cdk-lib.aws_ssm.StringParameterProps No description.
replicaRegions string[] No description.
existingStringParamObj aws-cdk-lib.aws_ssm.StringParameter No description.
tags {[ key: string ]: string}[] No description.
parameterPropsRequired 
public readonly parameterProps: StringParameterProps;
  • Type: aws-cdk-lib.aws_ssm.StringParameterProps
replicaRegionsRequired 
public readonly replicaRegions: string[];
  • Type: string[]
existingStringParamObjOptional 
public readonly existingStringParamObj: StringParameter;
  • Type: aws-cdk-lib.aws_ssm.StringParameter
tagsOptional 
public readonly tags: {[ key: string ]: string}[];
  • Type: {[ key: string ]: string}[]