Class SsmParameterReader

ReadonlygrantPrincipal

Readonlynode

Static ReadonlyPROVIDER_FUNCTION_UUID

getResponseField

• getResponseField(dataPath: string): string

• Returns response data for the AWS SDK call as string.

  Example for S3 / listBucket : 'Buckets.0.Name'

  Note that you cannot use this method if ignoreErrorCodesMatching is configured for any of the SDK calls. This is because in such a case, the response data might not exist, and will cause a CloudFormation deploy time error.

  Parameters

  • dataPath: string

    the path to the data

  Returns string

getResponseFieldReference

• getResponseFieldReference(dataPath: string): Reference

• Returns response data for the AWS SDK call.

  Example for S3 / listBucket : 'Buckets.0.Name'

  Use Token.asXxx to encode the returned Reference as a specific type or use the convenience getDataString for string attributes.

  Note that you cannot use this method if ignoreErrorCodesMatching is configured for any of the SDK calls. This is because in such a case, the response data might not exist, and will cause a CloudFormation deploy time error.

  Parameters

  • dataPath: string

    the path to the data

  Returns Reference

toString

• toString(): string

• Returns a string representation of this construct.

  Returns string

StaticisConstruct

• isConstruct(x: any): x is Construct

• 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.

  Parameters

  • x: any

    Any object

  Returns x is Construct

  true if x is an object created from a class which extends Construct.