This documentation is for the developer preview release of the AWS CDK. Do not use this version of the AWS CDK in production. Subsequent releases of the AWS CDK will likely include breaking changes.

@aws-cdk/aws-ssm

The CDK Construct Library for AWS Systems Manager

This module is part of the AWS Cloud Development Kit project.

Installation

Install the module:

$ npm i @aws-cdk/aws-ssm

Import it into your code:

import ssm = require('@aws-cdk/aws-ssm');

Using existing SSM Parameters in your CDK app

You can reference existing SSM Parameter Store values that you want to use in your CDK app by using ssm.ParameterStoreString:

// Retrieve the latest value of the non-secret parameter
// with name "/My/String/Parameter".
const stringValue = new ssm.ParameterStoreString(this, 'MyValue', {
  parameterName: '/My/Public/Parameter',
  // 'version' can be specified but is optional.
}).stringValue;

// Retrieve a specific version of the secret (SecureString) parameter.
// 'version' is always required.
const secretValue = new ssm.ParameterStoreSecureString(this, 'SecretValue', {
  parameterName: '/My/Secret/Parameter',
  version: 5
}).stringValue;

Creating new SSM Parameters in your CDK app

You can create either ssm.StringParameter or ssm.StringListParameters in a CDK app. These are public (not secret) values. Parameters of type SecretString cannot be created directly from a CDK application; if you want to provision secrets automatically, use Secrets Manager Secrets (see the @aws-cdk/aws-secretsmanager package).

// Create a new SSM Parameter holding a String
const param = new ssm.StringParameter(stack, 'StringParameter', {
  // description: 'Some user-friendly description',
  // name: 'ParameterName',
  stringValue: 'Initial parameter value',
  // allowedPattern: '.*',
});

// Grant read access to some Role
param.grantRead(role);

// Create a new SSM Parameter holding a StringList
const listParameter = new ssm.StringListParameter(stack, 'StringListParameter', {
  // description: 'Some user-friendly description',
  // name: 'ParameterName',
  stringListValue: ['Initial parameter value A', 'Initial parameter value B'],
  // allowedPattern: '.*',
});

When specifying an allowedPattern, the values provided as string literals are validated against the pattern and an exception is raised if a value provided does not comply.

Reference

View in Nuget

csproj:

<PackageReference Include="Amazon.CDK.AWS.SSM" Version="0.25.3" />

dotnet:

dotnet add package Amazon.CDK.AWS.SSM --version 0.25.3

packages.config:

<package id="Amazon.CDK.AWS.SSM" version="0.25.3" />

View in Maven Central

Apache Buildr:

'software.amazon.awscdk:ssm:jar:0.25.3'

Apache Ivy:

<dependency groupId="software.amazon.awscdk" name="ssm" rev="0.25.3"/>

Apache Maven:

<dependency>
  <groupId>software.amazon.awscdk</groupId>
  <artifactId>ssm</artifactId>
  <version>0.25.3</version>
</dependency>

Gradle / Grails:

compile 'software.amazon.awscdk:ssm:0.25.3'

Groovy Grape:

@Grapes(
@Grab(group='software.amazon.awscdk', module='ssm', version='0.25.3')
)

View in NPM

npm:

$ npm i @aws-cdk/aws-ssm@0.25.3

package.json:

{
  "@aws-cdk/aws-ssm": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-ssm@0.25.3

View in NPM

npm:

$ npm i @aws-cdk/aws-ssm@0.25.3

package.json:

{
  "@aws-cdk/aws-ssm": "^0.25.3"
}

yarn:

$ yarn add @aws-cdk/aws-ssm@0.25.3

CfnAssociation

class @aws-cdk/aws-ssm.CfnAssociation(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.CfnAssociation;
const { CfnAssociation } = require('@aws-cdk/aws-ssm');
import { CfnAssociation } from '@aws-cdk/aws-ssm';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:CfnAssociationProps (readonly)
class InstanceAssociationOutputLocationProperty

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.CfnAssociation.InstanceAssociationOutputLocationProperty;
// CfnAssociation.InstanceAssociationOutputLocationProperty is an interface
import { CfnAssociation.InstanceAssociationOutputLocationProperty } from '@aws-cdk/aws-ssm';
s3Location

CfnAssociation.InstanceAssociationOutputLocationProperty.S3Location

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-instanceassociationoutputlocation.html#cfn-ssm-association-instanceassociationoutputlocation-s3location

Type:@aws-cdk/cdk.Token or S3OutputLocationProperty (optional)
class ParameterValuesProperty

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.CfnAssociation.ParameterValuesProperty;
// CfnAssociation.ParameterValuesProperty is an interface
import { CfnAssociation.ParameterValuesProperty } from '@aws-cdk/aws-ssm';
parameterValues

CfnAssociation.ParameterValuesProperty.ParameterValues

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-parametervalues.html#cfn-ssm-association-parametervalues-parametervalues

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[]
class S3OutputLocationProperty

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.CfnAssociation.S3OutputLocationProperty;
// CfnAssociation.S3OutputLocationProperty is an interface
import { CfnAssociation.S3OutputLocationProperty } from '@aws-cdk/aws-ssm';
outputS3BucketName

CfnAssociation.S3OutputLocationProperty.OutputS3BucketName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-s3outputlocation.html#cfn-ssm-association-s3outputlocation-outputs3bucketname

Type:string (optional)
outputS3KeyPrefix

CfnAssociation.S3OutputLocationProperty.OutputS3KeyPrefix

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-s3outputlocation.html#cfn-ssm-association-s3outputlocation-outputs3keyprefix

Type:string (optional)
class TargetProperty

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.CfnAssociation.TargetProperty;
// CfnAssociation.TargetProperty is an interface
import { CfnAssociation.TargetProperty } from '@aws-cdk/aws-ssm';
key

CfnAssociation.TargetProperty.Key

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-target.html#cfn-ssm-association-target-key

Type:string
values

CfnAssociation.TargetProperty.Values

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-association-target.html#cfn-ssm-association-target-values

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[]
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnAssociationProps (interface)

class @aws-cdk/aws-ssm.CfnAssociationProps

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.CfnAssociationProps;
// CfnAssociationProps is an interface
import { CfnAssociationProps } from '@aws-cdk/aws-ssm';
name

AWS::SSM::Association.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-name

Type:string
associationName

AWS::SSM::Association.AssociationName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-associationname

Type:string (optional)
documentVersion

AWS::SSM::Association.DocumentVersion

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-documentversion

Type:string (optional)
instanceId

AWS::SSM::Association.InstanceId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-instanceid

Type:string (optional)
outputLocation

AWS::SSM::Association.OutputLocation

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-outputlocation

Type:InstanceAssociationOutputLocationProperty or @aws-cdk/cdk.Token (optional)
parameters

AWS::SSM::Association.Parameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-parameters

Type:@aws-cdk/cdk.Token or string => (@aws-cdk/cdk.Token or ParameterValuesProperty) (optional)
scheduleExpression

AWS::SSM::Association.ScheduleExpression

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-scheduleexpression

Type:string (optional)
targets

AWS::SSM::Association.Targets

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-association.html#cfn-ssm-association-targets

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or TargetProperty)[] (optional)

CfnDocument

class @aws-cdk/aws-ssm.CfnDocument(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.CfnDocument;
const { CfnDocument } = require('@aws-cdk/aws-ssm');
import { CfnDocument } from '@aws-cdk/aws-ssm';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
documentName
Type:string (readonly)
propertyOverrides
Type:CfnDocumentProps (readonly)
tags

The TagManager handles setting, removing and formatting tags

Tags should be managed either passing them as properties during

initiation or by calling methods on this object. If both techniques are

used only the tags from the TagManager will be used. Tag (aspect)

will use the manager.

Type:@aws-cdk/cdk.TagManager (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnDocumentProps (interface)

class @aws-cdk/aws-ssm.CfnDocumentProps

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.CfnDocumentProps;
// CfnDocumentProps is an interface
import { CfnDocumentProps } from '@aws-cdk/aws-ssm';
content

AWS::SSM::Document.Content

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-content

Type:json or @aws-cdk/cdk.Token
documentType

AWS::SSM::Document.DocumentType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-documenttype

Type:string (optional)
tags

AWS::SSM::Document.Tags

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-document.html#cfn-ssm-document-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.CfnTag)[] (optional)

CfnMaintenanceWindow

class @aws-cdk/aws-ssm.CfnMaintenanceWindow(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.CfnMaintenanceWindow;
const { CfnMaintenanceWindow } = require('@aws-cdk/aws-ssm');
import { CfnMaintenanceWindow } from '@aws-cdk/aws-ssm';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
maintenanceWindowId
Type:string (readonly)
propertyOverrides
Type:CfnMaintenanceWindowProps (readonly)
tags

The TagManager handles setting, removing and formatting tags

Tags should be managed either passing them as properties during

initiation or by calling methods on this object. If both techniques are

used only the tags from the TagManager will be used. Tag (aspect)

will use the manager.

Type:@aws-cdk/cdk.TagManager (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnMaintenanceWindowProps (interface)

class @aws-cdk/aws-ssm.CfnMaintenanceWindowProps

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.CfnMaintenanceWindowProps;
// CfnMaintenanceWindowProps is an interface
import { CfnMaintenanceWindowProps } from '@aws-cdk/aws-ssm';
allowUnassociatedTargets

AWS::SSM::MaintenanceWindow.AllowUnassociatedTargets

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-allowunassociatedtargets

Type:boolean or @aws-cdk/cdk.Token
cutoff

AWS::SSM::MaintenanceWindow.Cutoff

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-cutoff

Type:number or @aws-cdk/cdk.Token
duration

AWS::SSM::MaintenanceWindow.Duration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-duration

Type:number or @aws-cdk/cdk.Token
name

AWS::SSM::MaintenanceWindow.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-name

Type:string
schedule

AWS::SSM::MaintenanceWindow.Schedule

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-schedule

Type:string
description

AWS::SSM::MaintenanceWindow.Description

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-description

Type:string (optional)
endDate

AWS::SSM::MaintenanceWindow.EndDate

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-enddate

Type:string (optional)
scheduleTimezone

AWS::SSM::MaintenanceWindow.ScheduleTimezone

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-scheduletimezone

Type:string (optional)
startDate

AWS::SSM::MaintenanceWindow.StartDate

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-startdate

Type:string (optional)
tags

AWS::SSM::MaintenanceWindow.Tags

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindow.html#cfn-ssm-maintenancewindow-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.CfnTag)[] (optional)

CfnMaintenanceWindowTask

class @aws-cdk/aws-ssm.CfnMaintenanceWindowTask(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.CfnMaintenanceWindowTask;
const { CfnMaintenanceWindowTask } = require('@aws-cdk/aws-ssm');
import { CfnMaintenanceWindowTask } from '@aws-cdk/aws-ssm';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
maintenanceWindowTaskId
Type:string (readonly)
propertyOverrides
Type:CfnMaintenanceWindowTaskProps (readonly)
class LoggingInfoProperty

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.CfnMaintenanceWindowTask.LoggingInfoProperty;
// CfnMaintenanceWindowTask.LoggingInfoProperty is an interface
import { CfnMaintenanceWindowTask.LoggingInfoProperty } from '@aws-cdk/aws-ssm';
region

CfnMaintenanceWindowTask.LoggingInfoProperty.Region

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.html#cfn-ssm-maintenancewindowtask-logginginfo-region

Type:string
s3Bucket

CfnMaintenanceWindowTask.LoggingInfoProperty.S3Bucket

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.html#cfn-ssm-maintenancewindowtask-logginginfo-s3bucket

Type:string
s3Prefix

CfnMaintenanceWindowTask.LoggingInfoProperty.S3Prefix

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.html#cfn-ssm-maintenancewindowtask-logginginfo-s3prefix

Type:string (optional)
class MaintenanceWindowAutomationParametersProperty

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.CfnMaintenanceWindowTask.MaintenanceWindowAutomationParametersProperty;
// CfnMaintenanceWindowTask.MaintenanceWindowAutomationParametersProperty is an interface
import { CfnMaintenanceWindowTask.MaintenanceWindowAutomationParametersProperty } from '@aws-cdk/aws-ssm';
documentVersion

CfnMaintenanceWindowTask.MaintenanceWindowAutomationParametersProperty.DocumentVersion

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowautomationparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowautomationparameters-documentversion

Type:string (optional)
parameters

CfnMaintenanceWindowTask.MaintenanceWindowAutomationParametersProperty.Parameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowautomationparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowautomationparameters-parameters

Type:json or @aws-cdk/cdk.Token (optional)
class MaintenanceWindowLambdaParametersProperty

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.CfnMaintenanceWindowTask.MaintenanceWindowLambdaParametersProperty;
// CfnMaintenanceWindowTask.MaintenanceWindowLambdaParametersProperty is an interface
import { CfnMaintenanceWindowTask.MaintenanceWindowLambdaParametersProperty } from '@aws-cdk/aws-ssm';
clientContext

CfnMaintenanceWindowTask.MaintenanceWindowLambdaParametersProperty.ClientContext

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowlambdaparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowlambdaparameters-clientcontext

Type:string (optional)
payload

CfnMaintenanceWindowTask.MaintenanceWindowLambdaParametersProperty.Payload

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowlambdaparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowlambdaparameters-payload

Type:string (optional)
qualifier

CfnMaintenanceWindowTask.MaintenanceWindowLambdaParametersProperty.Qualifier

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowlambdaparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowlambdaparameters-qualifier

Type:string (optional)
class MaintenanceWindowRunCommandParametersProperty

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty;
// CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty is an interface
import { CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty } from '@aws-cdk/aws-ssm';
comment

CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty.Comment

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-comment

Type:string (optional)
documentHash

CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty.DocumentHash

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-documenthash

Type:string (optional)
documentHashType

CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty.DocumentHashType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-documenthashtype

Type:string (optional)
notificationConfig

CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty.NotificationConfig

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-notificationconfig

Type:@aws-cdk/cdk.Token or NotificationConfigProperty (optional)
outputS3BucketName

CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty.OutputS3BucketName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-outputs3bucketname

Type:string (optional)
outputS3KeyPrefix

CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty.OutputS3KeyPrefix

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-outputs3keyprefix

Type:string (optional)
parameters

CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty.Parameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-parameters

Type:json or @aws-cdk/cdk.Token (optional)
serviceRoleArn

CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty.ServiceRoleArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-servicerolearn

Type:string (optional)
timeoutSeconds

CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty.TimeoutSeconds

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-timeoutseconds

Type:number or @aws-cdk/cdk.Token (optional)
class MaintenanceWindowStepFunctionsParametersProperty

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.CfnMaintenanceWindowTask.MaintenanceWindowStepFunctionsParametersProperty;
// CfnMaintenanceWindowTask.MaintenanceWindowStepFunctionsParametersProperty is an interface
import { CfnMaintenanceWindowTask.MaintenanceWindowStepFunctionsParametersProperty } from '@aws-cdk/aws-ssm';
input

CfnMaintenanceWindowTask.MaintenanceWindowStepFunctionsParametersProperty.Input

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters-input

Type:string (optional)
name

CfnMaintenanceWindowTask.MaintenanceWindowStepFunctionsParametersProperty.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters-name

Type:string (optional)
class NotificationConfigProperty

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.CfnMaintenanceWindowTask.NotificationConfigProperty;
// CfnMaintenanceWindowTask.NotificationConfigProperty is an interface
import { CfnMaintenanceWindowTask.NotificationConfigProperty } from '@aws-cdk/aws-ssm';
notificationArn

CfnMaintenanceWindowTask.NotificationConfigProperty.NotificationArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html#cfn-ssm-maintenancewindowtask-notificationconfig-notificationarn

Type:string
notificationEvents

CfnMaintenanceWindowTask.NotificationConfigProperty.NotificationEvents

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html#cfn-ssm-maintenancewindowtask-notificationconfig-notificationevents

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
notificationType

CfnMaintenanceWindowTask.NotificationConfigProperty.NotificationType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html#cfn-ssm-maintenancewindowtask-notificationconfig-notificationtype

Type:string (optional)
class TargetProperty

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.CfnMaintenanceWindowTask.TargetProperty;
// CfnMaintenanceWindowTask.TargetProperty is an interface
import { CfnMaintenanceWindowTask.TargetProperty } from '@aws-cdk/aws-ssm';
key

CfnMaintenanceWindowTask.TargetProperty.Key

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-target.html#cfn-ssm-maintenancewindowtask-target-key

Type:string
values

CfnMaintenanceWindowTask.TargetProperty.Values

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-target.html#cfn-ssm-maintenancewindowtask-target-values

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
class TaskInvocationParametersProperty

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.CfnMaintenanceWindowTask.TaskInvocationParametersProperty;
// CfnMaintenanceWindowTask.TaskInvocationParametersProperty is an interface
import { CfnMaintenanceWindowTask.TaskInvocationParametersProperty } from '@aws-cdk/aws-ssm';
maintenanceWindowAutomationParameters

CfnMaintenanceWindowTask.TaskInvocationParametersProperty.MaintenanceWindowAutomationParameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters-maintenancewindowautomationparameters

Type:@aws-cdk/cdk.Token or MaintenanceWindowAutomationParametersProperty (optional)
maintenanceWindowLambdaParameters

CfnMaintenanceWindowTask.TaskInvocationParametersProperty.MaintenanceWindowLambdaParameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters-maintenancewindowlambdaparameters

Type:@aws-cdk/cdk.Token or MaintenanceWindowLambdaParametersProperty (optional)
maintenanceWindowRunCommandParameters

CfnMaintenanceWindowTask.TaskInvocationParametersProperty.MaintenanceWindowRunCommandParameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters-maintenancewindowruncommandparameters

Type:@aws-cdk/cdk.Token or MaintenanceWindowRunCommandParametersProperty (optional)
maintenanceWindowStepFunctionsParameters

CfnMaintenanceWindowTask.TaskInvocationParametersProperty.MaintenanceWindowStepFunctionsParameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-taskinvocationparameters.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters-maintenancewindowstepfunctionsparameters

Type:@aws-cdk/cdk.Token or MaintenanceWindowStepFunctionsParametersProperty (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnMaintenanceWindowTaskProps (interface)

class @aws-cdk/aws-ssm.CfnMaintenanceWindowTaskProps

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.CfnMaintenanceWindowTaskProps;
// CfnMaintenanceWindowTaskProps is an interface
import { CfnMaintenanceWindowTaskProps } from '@aws-cdk/aws-ssm';
maxConcurrency

AWS::SSM::MaintenanceWindowTask.MaxConcurrency

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-maxconcurrency

Type:string
maxErrors

AWS::SSM::MaintenanceWindowTask.MaxErrors

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-maxerrors

Type:string
priority

AWS::SSM::MaintenanceWindowTask.Priority

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-priority

Type:number or @aws-cdk/cdk.Token
serviceRoleArn

AWS::SSM::MaintenanceWindowTask.ServiceRoleArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-servicerolearn

Type:string
targets

AWS::SSM::MaintenanceWindowTask.Targets

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-targets

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or TargetProperty)[]
taskArn

AWS::SSM::MaintenanceWindowTask.TaskArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskarn

Type:string
taskType

AWS::SSM::MaintenanceWindowTask.TaskType

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-tasktype

Type:string
description

AWS::SSM::MaintenanceWindowTask.Description

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-description

Type:string (optional)
loggingInfo

AWS::SSM::MaintenanceWindowTask.LoggingInfo

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-logginginfo

Type:@aws-cdk/cdk.Token or LoggingInfoProperty (optional)
name

AWS::SSM::MaintenanceWindowTask.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-name

Type:string (optional)
taskInvocationParameters

AWS::SSM::MaintenanceWindowTask.TaskInvocationParameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters

Type:@aws-cdk/cdk.Token or TaskInvocationParametersProperty (optional)
taskParameters

AWS::SSM::MaintenanceWindowTask.TaskParameters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskparameters

Type:json or @aws-cdk/cdk.Token (optional)
windowId

AWS::SSM::MaintenanceWindowTask.WindowId

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-windowid

Type:string (optional)

CfnParameter

class @aws-cdk/aws-ssm.CfnParameter(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.CfnParameter;
const { CfnParameter } = require('@aws-cdk/aws-ssm');
import { CfnParameter } from '@aws-cdk/aws-ssm';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
parameterName
Type:string (readonly)
parameterType
Type:string (readonly)
parameterValue
Type:string (readonly)
propertyOverrides
Type:CfnParameterProps (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnParameterProps (interface)

class @aws-cdk/aws-ssm.CfnParameterProps

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.CfnParameterProps;
// CfnParameterProps is an interface
import { CfnParameterProps } from '@aws-cdk/aws-ssm';
type

AWS::SSM::Parameter.Type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-type

Type:string
value

AWS::SSM::Parameter.Value

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-value

Type:string
allowedPattern

AWS::SSM::Parameter.AllowedPattern

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-allowedpattern

Type:string (optional)
description

AWS::SSM::Parameter.Description

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-description

Type:string (optional)
name

AWS::SSM::Parameter.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-name

Type:string (optional)

CfnPatchBaseline

class @aws-cdk/aws-ssm.CfnPatchBaseline(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.CfnPatchBaseline;
const { CfnPatchBaseline } = require('@aws-cdk/aws-ssm');
import { CfnPatchBaseline } from '@aws-cdk/aws-ssm';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
patchBaselineId
Type:string (readonly)
propertyOverrides
Type:CfnPatchBaselineProps (readonly)
tags

The TagManager handles setting, removing and formatting tags

Tags should be managed either passing them as properties during

initiation or by calling methods on this object. If both techniques are

used only the tags from the TagManager will be used. Tag (aspect)

will use the manager.

Type:@aws-cdk/cdk.TagManager (readonly)
class PatchFilterGroupProperty

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.CfnPatchBaseline.PatchFilterGroupProperty;
// CfnPatchBaseline.PatchFilterGroupProperty is an interface
import { CfnPatchBaseline.PatchFilterGroupProperty } from '@aws-cdk/aws-ssm';
patchFilters

CfnPatchBaseline.PatchFilterGroupProperty.PatchFilters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfiltergroup.html#cfn-ssm-patchbaseline-patchfiltergroup-patchfilters

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or PatchFilterProperty)[] (optional)
class PatchFilterProperty

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.CfnPatchBaseline.PatchFilterProperty;
// CfnPatchBaseline.PatchFilterProperty is an interface
import { CfnPatchBaseline.PatchFilterProperty } from '@aws-cdk/aws-ssm';
key

CfnPatchBaseline.PatchFilterProperty.Key

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfilter.html#cfn-ssm-patchbaseline-patchfilter-key

Type:string (optional)
values

CfnPatchBaseline.PatchFilterProperty.Values

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchfilter.html#cfn-ssm-patchbaseline-patchfilter-values

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
class PatchSourceProperty

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.CfnPatchBaseline.PatchSourceProperty;
// CfnPatchBaseline.PatchSourceProperty is an interface
import { CfnPatchBaseline.PatchSourceProperty } from '@aws-cdk/aws-ssm';
configuration

CfnPatchBaseline.PatchSourceProperty.Configuration

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchsource.html#cfn-ssm-patchbaseline-patchsource-configuration

Type:string (optional)
name

CfnPatchBaseline.PatchSourceProperty.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchsource.html#cfn-ssm-patchbaseline-patchsource-name

Type:string (optional)
products

CfnPatchBaseline.PatchSourceProperty.Products

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-patchsource.html#cfn-ssm-patchbaseline-patchsource-products

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
class RuleGroupProperty

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.CfnPatchBaseline.RuleGroupProperty;
// CfnPatchBaseline.RuleGroupProperty is an interface
import { CfnPatchBaseline.RuleGroupProperty } from '@aws-cdk/aws-ssm';
patchRules

CfnPatchBaseline.RuleGroupProperty.PatchRules

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rulegroup.html#cfn-ssm-patchbaseline-rulegroup-patchrules

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or RuleProperty)[] (optional)
class RuleProperty

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.CfnPatchBaseline.RuleProperty;
// CfnPatchBaseline.RuleProperty is an interface
import { CfnPatchBaseline.RuleProperty } from '@aws-cdk/aws-ssm';
approveAfterDays

CfnPatchBaseline.RuleProperty.ApproveAfterDays

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-approveafterdays

Type:number or @aws-cdk/cdk.Token (optional)
complianceLevel

CfnPatchBaseline.RuleProperty.ComplianceLevel

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-compliancelevel

Type:string (optional)
enableNonSecurity

CfnPatchBaseline.RuleProperty.EnableNonSecurity

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-enablenonsecurity

Type:boolean or @aws-cdk/cdk.Token (optional)
patchFilterGroup

CfnPatchBaseline.RuleProperty.PatchFilterGroup

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-patchbaseline-rule.html#cfn-ssm-patchbaseline-rule-patchfiltergroup

Type:@aws-cdk/cdk.Token or PatchFilterGroupProperty (optional)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnPatchBaselineProps (interface)

class @aws-cdk/aws-ssm.CfnPatchBaselineProps

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.CfnPatchBaselineProps;
// CfnPatchBaselineProps is an interface
import { CfnPatchBaselineProps } from '@aws-cdk/aws-ssm';
name

AWS::SSM::PatchBaseline.Name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-name

Type:string
approvalRules

AWS::SSM::PatchBaseline.ApprovalRules

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvalrules

Type:@aws-cdk/cdk.Token or RuleGroupProperty (optional)
approvedPatches

AWS::SSM::PatchBaseline.ApprovedPatches

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatches

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
approvedPatchesComplianceLevel

AWS::SSM::PatchBaseline.ApprovedPatchesComplianceLevel

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatchescompliancelevel

Type:string (optional)
approvedPatchesEnableNonSecurity

AWS::SSM::PatchBaseline.ApprovedPatchesEnableNonSecurity

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-approvedpatchesenablenonsecurity

Type:boolean or @aws-cdk/cdk.Token (optional)
description

AWS::SSM::PatchBaseline.Description

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-description

Type:string (optional)
globalFilters

AWS::SSM::PatchBaseline.GlobalFilters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-globalfilters

Type:@aws-cdk/cdk.Token or PatchFilterGroupProperty (optional)
operatingSystem

AWS::SSM::PatchBaseline.OperatingSystem

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-operatingsystem

Type:string (optional)
patchGroups

AWS::SSM::PatchBaseline.PatchGroups

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-patchgroups

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
rejectedPatches

AWS::SSM::PatchBaseline.RejectedPatches

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-rejectedpatches

Type:@aws-cdk/cdk.Token or (string or @aws-cdk/cdk.Token)[] (optional)
rejectedPatchesAction

AWS::SSM::PatchBaseline.RejectedPatchesAction

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-rejectedpatchesaction

Type:string (optional)
sources

AWS::SSM::PatchBaseline.Sources

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-sources

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or PatchSourceProperty)[] (optional)
tags

AWS::SSM::PatchBaseline.Tags

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-patchbaseline.html#cfn-ssm-patchbaseline-tags

Type:@aws-cdk/cdk.Token or (@aws-cdk/cdk.Token or @aws-cdk/cdk.CfnTag)[] (optional)

CfnResourceDataSync

class @aws-cdk/aws-ssm.CfnResourceDataSync(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.CfnResourceDataSync;
const { CfnResourceDataSync } = require('@aws-cdk/aws-ssm');
import { CfnResourceDataSync } from '@aws-cdk/aws-ssm';
Extends:

@aws-cdk/cdk.Resource

Parameters:
renderProperties(properties) → string => any

Overrides @aws-cdk/cdk.Resource.renderProperties()

Protected method

Parameters:properties (any) –
Return type:string => any
resourceTypeName

The CloudFormation resource type name for this resource class.

Type:string (readonly) (static)
propertyOverrides
Type:CfnResourceDataSyncProps (readonly)
resourceDataSyncName
Type:string (readonly)
toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
ref

Inherited from @aws-cdk/cdk.Referenceable

Returns a token to a CloudFormation { Ref } that references this entity based on it’s logical ID.

Type:string (readonly)
addDeletionOverride(path)

Inherited from @aws-cdk/cdk.Resource

Syntactic sugar for addOverride(path, undefined).

Parameters:path (string) – The path of the value to delete
addDependsOn(resource)

Inherited from @aws-cdk/cdk.Resource

Indicates that this resource depends on another resource and cannot be provisioned

unless the other resource has been successfully provisioned.

Parameters:resource (@aws-cdk/cdk.Resource) –
addOverride(path, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to the synthesized CloudFormation resource. To add a

property override, either use addPropertyOverride or prefix path with

“Properties.” (i.e. Properties.TopicName).

Parameters:
  • path (string) – The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
  • value (any) – The value. Could be primitive or complex.
addPropertyDeletionOverride(propertyPath)

Inherited from @aws-cdk/cdk.Resource

Adds an override that deletes the value of a property from the resource definition.

Parameters:propertyPath (string) – The path to the property.
addPropertyOverride(propertyPath, value)

Inherited from @aws-cdk/cdk.Resource

Adds an override to a resource property.

Syntactic sugar for addOverride(“Properties.<…>”, value).

Parameters:
  • propertyPath (string) – The path of the property
  • value (any) – The value
getAtt(attributeName) → @aws-cdk/cdk.CfnReference

Inherited from @aws-cdk/cdk.Resource

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility

in case there is no generated attribute.

Parameters:attributeName (string) – The name of the attribute.
Return type:@aws-cdk/cdk.CfnReference
toCloudFormation() → json

Inherited from @aws-cdk/cdk.Resource

Emits CloudFormation for this resource.

Return type:json
options

Inherited from @aws-cdk/cdk.Resource

Options for this resource, such as condition, update policy etc.

Type:@aws-cdk/cdk.ResourceOptions (readonly)
properties

Inherited from @aws-cdk/cdk.Resource

AWS resource properties.

This object is rendered via a call to “renderProperties(this.properties)”.

Protected property

Type:any (readonly)
resourceType

Inherited from @aws-cdk/cdk.Resource

AWS resource type.

Type:string (readonly)
untypedPropertyOverrides

Inherited from @aws-cdk/cdk.Resource

AWS resource property overrides.

During synthesis, the method “renderProperties(this.overrides)” is called

with this object, and merged on top of the output of

“renderProperties(this.properties)”.

Derived classes should expose a strongly-typed version of this object as

a public property called propertyOverrides.

Protected property

Type:any (readonly)
overrideLogicalId(newLogicalId)

Inherited from @aws-cdk/cdk.StackElement

Overrides the auto-generated logical ID with a specific ID.

Parameters:newLogicalId (string) – The new logical ID to use for this stack element.
prepare()

Inherited from @aws-cdk/cdk.StackElement

Automatically detect references in this StackElement

Protected method

creationStackTrace

Inherited from @aws-cdk/cdk.StackElement

Type:string[] (readonly)
logicalId

Inherited from @aws-cdk/cdk.StackElement

The logical ID for this CloudFormation stack element. The logical ID of the element

is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Type:string (readonly)
stackPath

Inherited from @aws-cdk/cdk.StackElement

Return the path with respect to the stack

Type:string (readonly)

CfnResourceDataSyncProps (interface)

class @aws-cdk/aws-ssm.CfnResourceDataSyncProps

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.CfnResourceDataSyncProps;
// CfnResourceDataSyncProps is an interface
import { CfnResourceDataSyncProps } from '@aws-cdk/aws-ssm';
bucketName

AWS::SSM::ResourceDataSync.BucketName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketname

Type:string
bucketRegion

AWS::SSM::ResourceDataSync.BucketRegion

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketregion

Type:string
syncFormat

AWS::SSM::ResourceDataSync.SyncFormat

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncformat

Type:string
syncName

AWS::SSM::ResourceDataSync.SyncName

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-syncname

Type:string
bucketPrefix

AWS::SSM::ResourceDataSync.BucketPrefix

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-bucketprefix

Type:string (optional)
kmsKeyArn

AWS::SSM::ResourceDataSync.KMSKeyArn

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-resourcedatasync.html#cfn-ssm-resourcedatasync-kmskeyarn

Type:string (optional)

IParameter (interface)

class @aws-cdk/aws-ssm.IParameter

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.IParameter;
// IParameter is an interface
import { IParameter } from '@aws-cdk/aws-ssm';

An SSM Parameter reference.

Extends:@aws-cdk/cdk.IConstruct
parameterArn

The ARN of the SSM Parameter resource.

Type:string (readonly)
parameterName

The name of the SSM Parameter resource.

Type:string (readonly)
parameterType

The type of the SSM Parameter resource.

Type:string (readonly)
grantRead(grantee)

Grants read (DescribeParameter, GetParameter, GetParameterHistory) permissions on the SSM Parameter.

Parameters:grantee (@aws-cdk/aws-iam.IPrincipal) – the role to be granted read-only access to the parameter.
Abstract:Yes
grantWrite(grantee)

Grants write (PutParameter) permissions on the SSM Parameter.

Parameters:grantee (@aws-cdk/aws-iam.IPrincipal) – the role to be granted write access to the parameter.
Abstract:Yes
node

Inherited from @aws-cdk/cdk.IConstruct

The construct node in the scope tree.

Type:@aws-cdk/cdk.ConstructNode (readonly)
dependencyRoots

Inherited from @aws-cdk/cdk.IDependable

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)

IStringListParameter (interface)

class @aws-cdk/aws-ssm.IStringListParameter

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.IStringListParameter;
// IStringListParameter is an interface
import { IStringListParameter } from '@aws-cdk/aws-ssm';

A StringList SSM Parameter.

Extends:IParameter
stringListValue

The parameter value. Value must not nest another parameter. Do not use {{}} in the value. Values in the array

cannot contain commas (,).

Type:string[] (readonly)
grantRead(grantee)

Inherited from @aws-cdk/aws-ssm.IParameter

Grants read (DescribeParameter, GetParameter, GetParameterHistory) permissions on the SSM Parameter.

Parameters:grantee (@aws-cdk/aws-iam.IPrincipal) – the role to be granted read-only access to the parameter.
Abstract:Yes
grantWrite(grantee)

Inherited from @aws-cdk/aws-ssm.IParameter

Grants write (PutParameter) permissions on the SSM Parameter.

Parameters:grantee (@aws-cdk/aws-iam.IPrincipal) – the role to be granted write access to the parameter.
Abstract:Yes
parameterArn

Inherited from @aws-cdk/aws-ssm.IParameter

The ARN of the SSM Parameter resource.

Type:string (readonly)
parameterName

Inherited from @aws-cdk/aws-ssm.IParameter

The name of the SSM Parameter resource.

Type:string (readonly)
parameterType

Inherited from @aws-cdk/aws-ssm.IParameter

The type of the SSM Parameter resource.

Type:string (readonly)
node

Inherited from @aws-cdk/cdk.IConstruct

The construct node in the scope tree.

Type:@aws-cdk/cdk.ConstructNode (readonly)
dependencyRoots

Inherited from @aws-cdk/cdk.IDependable

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)

IStringParameter (interface)

class @aws-cdk/aws-ssm.IStringParameter

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.IStringParameter;
// IStringParameter is an interface
import { IStringParameter } from '@aws-cdk/aws-ssm';

A String SSM Parameter.

Extends:IParameter
stringValue

The parameter value. Value must not nest another parameter. Do not use {{}} in the value.

Type:string (readonly)
grantRead(grantee)

Inherited from @aws-cdk/aws-ssm.IParameter

Grants read (DescribeParameter, GetParameter, GetParameterHistory) permissions on the SSM Parameter.

Parameters:grantee (@aws-cdk/aws-iam.IPrincipal) – the role to be granted read-only access to the parameter.
Abstract:Yes
grantWrite(grantee)

Inherited from @aws-cdk/aws-ssm.IParameter

Grants write (PutParameter) permissions on the SSM Parameter.

Parameters:grantee (@aws-cdk/aws-iam.IPrincipal) – the role to be granted write access to the parameter.
Abstract:Yes
parameterArn

Inherited from @aws-cdk/aws-ssm.IParameter

The ARN of the SSM Parameter resource.

Type:string (readonly)
parameterName

Inherited from @aws-cdk/aws-ssm.IParameter

The name of the SSM Parameter resource.

Type:string (readonly)
parameterType

Inherited from @aws-cdk/aws-ssm.IParameter

The type of the SSM Parameter resource.

Type:string (readonly)
node

Inherited from @aws-cdk/cdk.IConstruct

The construct node in the scope tree.

Type:@aws-cdk/cdk.ConstructNode (readonly)
dependencyRoots

Inherited from @aws-cdk/cdk.IDependable

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)

ParameterBase

class @aws-cdk/aws-ssm.ParameterBase(scope, id, _props)

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.ParameterBase;
const { ParameterBase } = require('@aws-cdk/aws-ssm');
import { ParameterBase } from '@aws-cdk/aws-ssm';

Basic features shared across all types of SSM Parameters.

Extends:

@aws-cdk/cdk.Construct

Implements:

IParameter

Abstract:

Yes

Parameters:
grantRead(grantee)

Implements @aws-cdk/aws-ssm.IParameter.grantRead()

Grants read (DescribeParameter, GetParameter, GetParameterHistory) permissions on the SSM Parameter.

Parameters:grantee (@aws-cdk/aws-iam.IPrincipal) –
grantWrite(grantee)

Implements @aws-cdk/aws-ssm.IParameter.grantWrite()

Grants write (PutParameter) permissions on the SSM Parameter.

Parameters:grantee (@aws-cdk/aws-iam.IPrincipal) –
parameterArn

Implements @aws-cdk/aws-ssm.IParameter.parameterArn()

The ARN of the SSM Parameter resource.

Type:string (readonly)
parameterName

Implements @aws-cdk/aws-ssm.IParameter.parameterName()

The name of the SSM Parameter resource.

Type:string (readonly) (abstract)
parameterType

Implements @aws-cdk/aws-ssm.IParameter.parameterType()

The type of the SSM Parameter resource.

Type:string (readonly) (abstract)
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

ParameterProps (interface)

class @aws-cdk/aws-ssm.ParameterProps

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.ParameterProps;
// ParameterProps is an interface
import { ParameterProps } from '@aws-cdk/aws-ssm';

Properties needed to create a new SSM Parameter.

allowedPattern

A regular expression used to validate the parameter value. For example, for String types with values restricted to

numbers, you can specify the following: ^\d+$

Type:string (optional)
Default:no validation is performed
description

Information about the parameter that you want to add to the system.

Type:string (optional)
Default:none
name

The name of the parameter.

Type:string (optional)
Default:a name will be generated by CloudFormation

ParameterStoreSecureString

class @aws-cdk/aws-ssm.ParameterStoreSecureString(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.ParameterStoreSecureString;
const { ParameterStoreSecureString } = require('@aws-cdk/aws-ssm');
import { ParameterStoreSecureString } from '@aws-cdk/aws-ssm';

References a secret value in AWS Systems Manager Parameter Store

It is not possible to retrieve the “latest” value of a secret.

Use Secrets Manager if you need that ability.

Extends:

@aws-cdk/cdk.DynamicReference

Parameters:
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)
makeResolveValue(service, referenceKey) → string

Inherited from @aws-cdk/cdk.DynamicReference

Make a dynamic reference Token value

This is a value (similar to CDK Tokens) that will be substituted by

CloudFormation before executing the changeset.

Protected method

Parameters:
Return type:

string

stringValue

Inherited from @aws-cdk/cdk.DynamicReference

The value of this dynamic reference

Type:string (readonly)

ParameterStoreSecureStringProps (interface)

class @aws-cdk/aws-ssm.ParameterStoreSecureStringProps

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.ParameterStoreSecureStringProps;
// ParameterStoreSecureStringProps is an interface
import { ParameterStoreSecureStringProps } from '@aws-cdk/aws-ssm';

Properties for a ParameterStoreValue

parameterName

The name of the parameter store secure string value

Type:string
version

The version number of the value you wish to retrieve.

Type:number

ParameterStoreString

class @aws-cdk/aws-ssm.ParameterStoreString(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.ParameterStoreString;
const { ParameterStoreString } = require('@aws-cdk/aws-ssm');
import { ParameterStoreString } from '@aws-cdk/aws-ssm';

References a public value in AWS Systems Manager Parameter Store

Extends:

@aws-cdk/cdk.Construct

Parameters:
stringValue
Type:string (readonly)
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

ParameterStoreStringProps (interface)

class @aws-cdk/aws-ssm.ParameterStoreStringProps

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.ParameterStoreStringProps;
// ParameterStoreStringProps is an interface
import { ParameterStoreStringProps } from '@aws-cdk/aws-ssm';

Properties for a ParameterStoreValue

parameterName

The name of the parameter store value

Type:string
version

The version number of the value you wish to retrieve.

Type:number (optional)
Default:The latest version will be retrieved.

StringListParameter

class @aws-cdk/aws-ssm.StringListParameter(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.StringListParameter;
const { StringListParameter } = require('@aws-cdk/aws-ssm');
import { StringListParameter } from '@aws-cdk/aws-ssm';

Creates a new StringList SSM Parameter.

Extends:

ParameterBase

Implements:

IStringListParameter

Parameters:
parameterName

Implements @aws-cdk/aws-ssm.IParameter.parameterName()

The name of the SSM Parameter resource.

Type:string (readonly)
parameterType

Implements @aws-cdk/aws-ssm.IParameter.parameterType()

The type of the SSM Parameter resource.

Type:string (readonly)
stringListValue

Implements @aws-cdk/aws-ssm.IStringListParameter.stringListValue()

The parameter value. Value must not nest another parameter. Do not use {{}} in the value. Values in the array

cannot contain commas (,).

Type:string[] (readonly)
grantRead(grantee)

Inherited from @aws-cdk/aws-ssm.ParameterBase

Grants read (DescribeParameter, GetParameter, GetParameterHistory) permissions on the SSM Parameter.

Parameters:grantee (@aws-cdk/aws-iam.IPrincipal) –
grantWrite(grantee)

Inherited from @aws-cdk/aws-ssm.ParameterBase

Grants write (PutParameter) permissions on the SSM Parameter.

Parameters:grantee (@aws-cdk/aws-iam.IPrincipal) –
parameterArn

Inherited from @aws-cdk/aws-ssm.ParameterBase

The ARN of the SSM Parameter resource.

Type:string (readonly)
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

StringListParameterProps (interface)

class @aws-cdk/aws-ssm.StringListParameterProps

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.StringListParameterProps;
// StringListParameterProps is an interface
import { StringListParameterProps } from '@aws-cdk/aws-ssm';

Properties needed to create a StringList SSM Parameter

Extends:ParameterProps
stringListValue

The values of the parameter. It may not reference another parameter and {{}} cannot be used in the value.

Type:string[]
allowedPattern

Inherited from @aws-cdk/aws-ssm.ParameterProps

A regular expression used to validate the parameter value. For example, for String types with values restricted to

numbers, you can specify the following: ^\d+$

Type:string (optional)
Default:no validation is performed
description

Inherited from @aws-cdk/aws-ssm.ParameterProps

Information about the parameter that you want to add to the system.

Type:string (optional)
Default:none
name

Inherited from @aws-cdk/aws-ssm.ParameterProps

The name of the parameter.

Type:string (optional)
Default:a name will be generated by CloudFormation

StringParameter

class @aws-cdk/aws-ssm.StringParameter(scope, id, props)

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.StringParameter;
const { StringParameter } = require('@aws-cdk/aws-ssm');
import { StringParameter } from '@aws-cdk/aws-ssm';

Creates a new String SSM Parameter.

Extends:

ParameterBase

Implements:

IStringParameter

Parameters:
parameterName

Implements @aws-cdk/aws-ssm.IParameter.parameterName()

The name of the SSM Parameter resource.

Type:string (readonly)
parameterType

Implements @aws-cdk/aws-ssm.IParameter.parameterType()

The type of the SSM Parameter resource.

Type:string (readonly)
stringValue

Implements @aws-cdk/aws-ssm.IStringParameter.stringValue()

The parameter value. Value must not nest another parameter. Do not use {{}} in the value.

Type:string (readonly)
grantRead(grantee)

Inherited from @aws-cdk/aws-ssm.ParameterBase

Grants read (DescribeParameter, GetParameter, GetParameterHistory) permissions on the SSM Parameter.

Parameters:grantee (@aws-cdk/aws-iam.IPrincipal) –
grantWrite(grantee)

Inherited from @aws-cdk/aws-ssm.ParameterBase

Grants write (PutParameter) permissions on the SSM Parameter.

Parameters:grantee (@aws-cdk/aws-iam.IPrincipal) –
parameterArn

Inherited from @aws-cdk/aws-ssm.ParameterBase

The ARN of the SSM Parameter resource.

Type:string (readonly)
prepare()

Inherited from @aws-cdk/cdk.Construct

Perform final modifications before synthesis

This method can be implemented by derived constructs in order to perform

final changes before synthesis. prepare() will be called after child

constructs have been prepared.

This is an advanced framework feature. Only use this if you

understand the implications.

Protected method

toString() → string

Inherited from @aws-cdk/cdk.Construct

Returns a string representation of this construct.

Return type:string
validate() → string[]

Inherited from @aws-cdk/cdk.Construct

Validate the current construct.

This method can be implemented by derived constructs in order to perform

validation logic. It is called on all constructs before synthesis.

Protected method

Returns:An array of validation error messages, or an empty array if there the construct is valid.
Return type:string[]
dependencyRoots

Inherited from @aws-cdk/cdk.Construct

The set of constructs that form the root of this dependable

All resources under all returned constructs are included in the ordering

dependency.

Type:@aws-cdk/cdk.IConstruct[] (readonly)
node

Inherited from @aws-cdk/cdk.Construct

Construct node.

Type:@aws-cdk/cdk.ConstructNode (readonly)

StringParameterProps (interface)

class @aws-cdk/aws-ssm.StringParameterProps

Language-specific names:

using Amazon.CDK.AWS.SSM;
import software.amazon.awscdk.services.ssm.StringParameterProps;
// StringParameterProps is an interface
import { StringParameterProps } from '@aws-cdk/aws-ssm';

Properties needed to create a String SSM parameter.

Extends:ParameterProps
stringValue

The value of the parameter. It may not reference another parameter and {{}} cannot be used in the value.

Type:string
allowedPattern

Inherited from @aws-cdk/aws-ssm.ParameterProps

A regular expression used to validate the parameter value. For example, for String types with values restricted to

numbers, you can specify the following: ^\d+$

Type:string (optional)
Default:no validation is performed
description

Inherited from @aws-cdk/aws-ssm.ParameterProps

Information about the parameter that you want to add to the system.

Type:string (optional)
Default:none
name

Inherited from @aws-cdk/aws-ssm.ParameterProps

The name of the parameter.

Type:string (optional)
Default:a name will be generated by CloudFormation