software.amazon.awscdk.services.ssm

Class CfnParameter

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.ssm.CfnParameter

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:20.930Z")
 @Stability(value=Stable)
public class CfnParameter
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SSM::Parameter`.

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 Requirements and Constraints for Parameter Names in the AWS Systems Manager User Guide and PutParameter in the AWS Systems Manager API Reference .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ssm.*;
 Object tags;
 CfnParameter cfnParameter = CfnParameter.Builder.create(this, "MyCfnParameter")
         .type("type")
         .value("value")
         // the properties below are optional
         .allowedPattern("allowedPattern")
         .dataType("dataType")
         .description("description")
         .name("name")
         .policies("policies")
         .tags(tags)
         .tier("tier")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnParameter.Builder A fluent builder for CfnParameter.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnParameter(Construct scope, String id, CfnParameterProps props) Create a new `AWS::SSM::Parameter`.
protected	CfnParameter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnParameter(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAllowedPattern() A regular expression used to validate the parameter value.
String	getAttrType() Returns the type of the parameter.
String	getAttrValue() Returns the value of the parameter.
protected Map<String,Object>	getCfnProperties()
String	getDataType() The data type of the parameter, such as `text` or `aws:ec2:image` .
String	getDescription() Information about the parameter.
String	getName() The name of the parameter.
String	getPolicies() Information about the policies assigned to a parameter.
TagManager	getTags() Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs).
String	getTier() The parameter tier.
String	getType() The type of parameter.
String	getValue() The parameter value.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAllowedPattern(String value) A regular expression used to validate the parameter value.
void	setDataType(String value) The data type of the parameter, such as `text` or `aws:ec2:image` .
void	setDescription(String value) Information about the parameter.
void	setName(String value) The name of the parameter.
void	setPolicies(String value) Information about the policies assigned to a parameter.
void	setTier(String value) The parameter tier.
void	setType(String value) The type of parameter.
void	setValue(String value) The parameter value.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnParameter

protected CfnParameter(software.amazon.jsii.JsiiObjectRef objRef)

CfnParameter

protected CfnParameter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnParameter

@Stability(value=Stable)
public CfnParameter(@NotNull
                                             Construct scope,
                                             @NotNull
                                             String id,
                                             @NotNull
                                             CfnParameterProps props)

Create a new `AWS::SSM::Parameter`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrType

@Stability(value=Stable)
 @NotNull
public String getAttrType()

Returns the type of the parameter.

Valid values are String or StringList .

getAttrValue

@Stability(value=Stable)
 @NotNull
public String getAttrValue()

Returns the value of the parameter.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs).

Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a Systems Manager parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.

getType

@Stability(value=Stable)
 @NotNull
public String getType()

The type of parameter.

AWS CloudFormation doesn't support creating a SecureString parameter type.

Allowed Values : String | StringList

setType

@Stability(value=Stable)
public void setType(@NotNull
                                             String value)

The type of parameter.

AWS CloudFormation doesn't support creating a SecureString parameter type.

Allowed Values : String | StringList

getValue

@Stability(value=Stable)
 @NotNull
public String getValue()

The parameter value.

If type is StringList , the system returns a comma-separated string with no spaces between commas in the Value field.

setValue

@Stability(value=Stable)
public void setValue(@NotNull
                                              String value)

The parameter value.

If type is StringList , the system returns a comma-separated string with no spaces between commas in the Value field.

getAllowedPattern

@Stability(value=Stable)
 @Nullable
public String getAllowedPattern()

A regular expression used to validate the parameter value.

For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$

setAllowedPattern

@Stability(value=Stable)
public void setAllowedPattern(@Nullable
                                                       String value)

A regular expression used to validate the parameter value.

For example, for String types with values restricted to numbers, you can specify the following: AllowedPattern=^\d+$

getDataType

@Stability(value=Stable)
 @Nullable
public String getDataType()

The data type of the parameter, such as `text` or `aws:ec2:image` .

The default is text .

setDataType

@Stability(value=Stable)
public void setDataType(@Nullable
                                                 String value)

The data type of the parameter, such as `text` or `aws:ec2:image` .

The default is text .

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

Information about the parameter.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

Information about the parameter.

getName

@Stability(value=Stable)
 @Nullable
public String getName()

The name of the parameter.

The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter ARN, is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

The name of the parameter.

The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter ARN, is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName

getPolicies

@Stability(value=Stable)
 @Nullable
public String getPolicies()

Information about the policies assigned to a parameter.

Assigning parameter policies in the AWS Systems Manager User Guide .

setPolicies

@Stability(value=Stable)
public void setPolicies(@Nullable
                                                 String value)

Information about the policies assigned to a parameter.

Assigning parameter policies in the AWS Systems Manager User Guide .

getTier

@Stability(value=Stable)
 @Nullable
public String getTier()

The parameter tier.

setTier

@Stability(value=Stable)
public void setTier(@Nullable
                                             String value)

The parameter tier.