CfnParameter

java.lang.Object
- 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:

IConstruct, IDependable, IInspectable
```
@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:52.084Z")
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 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

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

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnParameter(Construct scope, java.lang.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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAllowedPattern()` A regular expression used to validate the parameter value.
`java.lang.String`	`getAttrType()` Returns the type of the parameter.
`java.lang.String`	`getAttrValue()` Returns the value of the parameter.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getDataType()` The data type of the parameter, such as `text` or `aws:ec2:image` .
`java.lang.String`	`getDescription()` Information about the parameter.
`java.lang.String`	`getName()` The name of the parameter.
`java.lang.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).
`java.lang.String`	`getTier()` The parameter tier.
`java.lang.String`	`getType()` The type of parameter.
`java.lang.String`	`getValue()` The parameter value.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setAllowedPattern(java.lang.String value)` A regular expression used to validate the parameter value.
`void`	`setDataType(java.lang.String value)` The data type of the parameter, such as `text` or `aws:ec2:image` .
`void`	`setDescription(java.lang.String value)` Information about the parameter.
`void`	`setName(java.lang.String value)` The name of the parameter.
`void`	`setPolicies(java.lang.String value)` Information about the policies assigned to a parameter.
`void`	`setTier(java.lang.String value)` The parameter tier.
`void`	`setType(java.lang.String value)` The type of parameter.
`void`	`setValue(java.lang.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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.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
```
public CfnParameter(Construct scope,
                    java.lang.String id,
                    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
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrType
```
public java.lang.String getAttrType()
```
    Returns the type of the parameter.
    Valid values are String or StringList .
  - getAttrValue
```
public java.lang.String getAttrValue()
```
    Returns the value of the parameter.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
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
```
public java.lang.String getType()
```
    The type of parameter.
    
    AWS CloudFormation doesn't support creating a SecureString parameter type.
    
    Allowed Values : String | StringList
  - setType
```
public void setType(java.lang.String value)
```
    The type of parameter.
    
    AWS CloudFormation doesn't support creating a SecureString parameter type.
    
    Allowed Values : String | StringList
  - getValue
```
public java.lang.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
```
public void setValue(java.lang.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
```
public java.lang.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
```
public void setAllowedPattern(java.lang.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
```
public java.lang.String getDataType()
```
    The data type of the parameter, such as `text` or `aws:ec2:image` .
    The default is text .
  - setDataType
```
public void setDataType(java.lang.String value)
```
    The data type of the parameter, such as `text` or `aws:ec2:image` .
    The default is text .
  - getDescription
```
public java.lang.String getDescription()
```
    Information about the parameter.
  - setDescription
```
public void setDescription(java.lang.String value)
```
    Information about the parameter.
  - getName
```
public java.lang.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
```
public void setName(java.lang.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
```
public java.lang.String getPolicies()
```
    Information about the policies assigned to a parameter.
    Assigning parameter policies in the AWS Systems Manager User Guide .
  - setPolicies
```
public void setPolicies(java.lang.String value)
```
    Information about the policies assigned to a parameter.
    Assigning parameter policies in the AWS Systems Manager User Guide .
  - getTier
```
public java.lang.String getTier()
```
    The parameter tier.
  - setTier
```
public void setTier(java.lang.String value)
```
    The parameter tier.

Class CfnParameter

Nested Class Summary

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

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

Field Summary

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnParameter

CfnParameter

CfnParameter

Method Detail

inspect

renderProperties

getAttrType

getAttrValue

getCfnProperties

getTags

getType

setType

getValue

setValue

getAllowedPattern

setAllowedPattern

getDataType

setDataType

getDescription

setDescription

getName

setName

getPolicies

setPolicies

getTier

setTier