class CfnParameterPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.SSM.Mixins.CfnParameterPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsssm/mixins#CfnParameterPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.ssm.mixins.CfnParameterPropsMixin
Python	aws_cdk.mixins_preview.aws_ssm.mixins.CfnParameterPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_ssm » mixins » CfnParameterPropsMixin

Implements IMixin

Extends Mixin

The AWS::SSM::Parameter resource creates an SSM parameter in AWS Systems Manager Parameter Store.

To create an SSM parameter, you must have the AWS Identity and Access Management ( IAM ) permissions ssm:PutParameter and ssm:AddTagsToResource . On stack creation, AWS CloudFormation adds the following three tags to the parameter: aws:cloudformation:stack-name , aws:cloudformation:logical-id , and aws:cloudformation:stack-id , in addition to any custom tags you specify.

To add, update, or remove tags during stack update, you must have IAM permissions for both ssm:AddTagsToResource and ssm:RemoveTagsFromResource . For more information, see Managing access using policies in the AWS Systems Manager User Guide .

For information about valid values for parameters, see About requirements and constraints for parameter names in the AWS Systems Manager User Guide and PutParameter in the AWS Systems Manager API Reference .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as ssm_mixins } from '@aws-cdk/mixins-preview/aws-ssm';
const cfnParameterPropsMixin = new ssm_mixins.CfnParameterPropsMixin({
  allowedPattern: 'allowedPattern',
  dataType: 'dataType',
  description: 'description',
  name: 'name',
  policies: 'policies',
  tags: {
    tagsKey: 'tags',
  },
  tier: 'tier',
  type: 'type',
  value: 'value',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnParameterPropsMixin(props: CfnParameterMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnParameterMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::SSM::Parameter.

Properties

Name	Type	Description
props	CfnParameterMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnParameterMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.