The AWS::SSM::Parameter resource creates an SSM parameter in SYSlong Parameter Store.
To create an SSM parameter, you must have the IAMlong (IAM) permissions ssm:PutParameter and ssm:AddTagsToResource. On stack creation, CFNlong 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 User Guide.
For information about valid values for parameters, see About requirements and constraints for parameter names in the User Guide and PutParameter in the API Reference.
Using getParameter
Two invocation forms are available. The direct form accepts plain
arguments and either blocks until the result value is available, or
returns a Promise-wrapped result. The output form accepts
Input-wrapped arguments and returns an Output-wrapped result.
> Note: This function is named LookupParameter in the Go SDK.
public static CompletableFuture<GetParameterResult> getParameter(GetParameterArgs args, InvokeOptions options)
public static Output<GetParameterResult> getParameter(GetParameterArgs args, InvokeOptions options)
public static Output<GetParameterResult> getParameter(GetParameterArgs args, InvokeOutputOptions options)
fn::invoke:
function: aws-native:ssm:getParameter
arguments:
# arguments dictionary
data "aws-native_ssm_get_parameter" "name" {
# arguments
}
The following arguments are supported:
- Name
string
- The name of the parameter.
The reported maximum length of 2048 characters for a parameter name includes 1037 characters that are reserved for internal use by SYS. The maximum length for a parameter name that you specify is 1011 characters.
This count of 1011 characters includes the characters in the ARN that precede the name you specify. This ARN length will vary depending on your partition and Region. For example, the following 45 characters count toward the 1011 character maximum for a parameter created in the US East (Ohio) Region:
arn:aws:ssm:us-east-2:111122223333:parameter/.
- Name
string
- The name of the parameter.
The reported maximum length of 2048 characters for a parameter name includes 1037 characters that are reserved for internal use by SYS. The maximum length for a parameter name that you specify is 1011 characters.
This count of 1011 characters includes the characters in the ARN that precede the name you specify. This ARN length will vary depending on your partition and Region. For example, the following 45 characters count toward the 1011 character maximum for a parameter created in the US East (Ohio) Region:
arn:aws:ssm:us-east-2:111122223333:parameter/.
- name
string
- The name of the parameter.
The reported maximum length of 2048 characters for a parameter name includes 1037 characters that are reserved for internal use by SYS. The maximum length for a parameter name that you specify is 1011 characters.
This count of 1011 characters includes the characters in the ARN that precede the name you specify. This ARN length will vary depending on your partition and Region. For example, the following 45 characters count toward the 1011 character maximum for a parameter created in the US East (Ohio) Region:
arn:aws:ssm:us-east-2:111122223333:parameter/.
- name
String
- The name of the parameter.
The reported maximum length of 2048 characters for a parameter name includes 1037 characters that are reserved for internal use by SYS. The maximum length for a parameter name that you specify is 1011 characters.
This count of 1011 characters includes the characters in the ARN that precede the name you specify. This ARN length will vary depending on your partition and Region. For example, the following 45 characters count toward the 1011 character maximum for a parameter created in the US East (Ohio) Region:
arn:aws:ssm:us-east-2:111122223333:parameter/.
- name
string
- The name of the parameter.
The reported maximum length of 2048 characters for a parameter name includes 1037 characters that are reserved for internal use by SYS. The maximum length for a parameter name that you specify is 1011 characters.
This count of 1011 characters includes the characters in the ARN that precede the name you specify. This ARN length will vary depending on your partition and Region. For example, the following 45 characters count toward the 1011 character maximum for a parameter created in the US East (Ohio) Region:
arn:aws:ssm:us-east-2:111122223333:parameter/.
- name
str
- The name of the parameter.
The reported maximum length of 2048 characters for a parameter name includes 1037 characters that are reserved for internal use by SYS. The maximum length for a parameter name that you specify is 1011 characters.
This count of 1011 characters includes the characters in the ARN that precede the name you specify. This ARN length will vary depending on your partition and Region. For example, the following 45 characters count toward the 1011 character maximum for a parameter created in the US East (Ohio) Region:
arn:aws:ssm:us-east-2:111122223333:parameter/.
- name
String
- The name of the parameter.
The reported maximum length of 2048 characters for a parameter name includes 1037 characters that are reserved for internal use by SYS. The maximum length for a parameter name that you specify is 1011 characters.
This count of 1011 characters includes the characters in the ARN that precede the name you specify. This ARN length will vary depending on your partition and Region. For example, the following 45 characters count toward the 1011 character maximum for a parameter created in the US East (Ohio) Region:
arn:aws:ssm:us-east-2:111122223333:parameter/.
getParameter Result
The following output properties are available:
- Arn
string
- DataType
Pulumi.AwsNative.Ssm.ParameterDataType
- The data type of the parameter, such as
text or aws:ec2:image. The default is text. - Tags
Dictionary<string, string>
- 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 SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.
- Type
Pulumi.AwsNative.Ssm.ParameterType
- The type of parameter.
Parameters of type
SecureString are not supported by CFNlong. - Value
string
- The parameter value.
If type is
StringList, the system returns a comma-separated string with no spaces between commas in the Value field.
- Arn
string
- DataType
ParameterDataType
- The data type of the parameter, such as
text or aws:ec2:image. The default is text. - Tags
map[string]string
- 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 SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.
- Type
ParameterType
- The type of parameter.
Parameters of type
SecureString are not supported by CFNlong. - Value
string
- The parameter value.
If type is
StringList, the system returns a comma-separated string with no spaces between commas in the Value field.
- arn
string
- data_type
"text" | "aws:ec2:image"
- The data type of the parameter, such as
text or aws:ec2:image. The default is text. - tags
map(string)
- 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 SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.
- type
"String" | "StringList"
- The type of parameter.
Parameters of type
SecureString are not supported by CFNlong. - value
string
- The parameter value.
If type is
StringList, the system returns a comma-separated string with no spaces between commas in the Value field.
- arn
String
- dataType
ParameterDataType
- The data type of the parameter, such as
text or aws:ec2:image. The default is text. - tags
Map<String,String>
- 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 SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.
- type
ParameterType
- The type of parameter.
Parameters of type
SecureString are not supported by CFNlong. - value
String
- The parameter value.
If type is
StringList, the system returns a comma-separated string with no spaces between commas in the Value field.
- arn
string
- dataType
ParameterDataType
- The data type of the parameter, such as
text or aws:ec2:image. The default is text. - tags
{[key: string]: string}
- 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 SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.
- type
ParameterType
- The type of parameter.
Parameters of type
SecureString are not supported by CFNlong. - value
string
- The parameter value.
If type is
StringList, the system returns a comma-separated string with no spaces between commas in the Value field.
- arn
str
- data_type
ParameterDataType
- The data type of the parameter, such as
text or aws:ec2:image. The default is text. - tags
Mapping[str, str]
- 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 SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.
- type
ParameterType
- The type of parameter.
Parameters of type
SecureString are not supported by CFNlong. - value
str
- The parameter value.
If type is
StringList, the system returns a comma-separated string with no spaces between commas in the Value field.
- arn
String
- dataType
"text" | "aws:ec2:image"
- The data type of the parameter, such as
text or aws:ec2:image. The default is text. - tags
Map<String>
- 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 SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter.
- type
"String" | "StringList"
- The type of parameter.
Parameters of type
SecureString are not supported by CFNlong. - value
String
- The parameter value.
If type is
StringList, the system returns a comma-separated string with no spaces between commas in the Value field.
Supporting Types
ParameterDataType
| Name | Value |
|---|
| Text | text |
| Awsec2image | aws:ec2:image |
| Name | Value |
|---|
| ParameterDataTypeText | text |
| ParameterDataTypeAwsec2image | aws:ec2:image |
| Name | Value |
|---|
| Text | text |
| Awsec2image | aws:ec2:image |
| Name | Value |
|---|
| Text | text |
| Awsec2image | aws:ec2:image |
| Name | Value |
|---|
| TEXT | text |
| AWSEC2IMAGE | aws:ec2:image |
ParameterType
| Name | Value |
|---|
| String | String |
| StringList | StringList |
| Name | Value |
|---|
| ParameterTypeString | String |
| ParameterTypeStringList | StringList |
| Name | Value |
|---|
| String | String |
| StringList | StringList |
| Name | Value |
|---|
| String | String |
| StringList | StringList |
| Name | Value |
|---|
| STRING | String |
| STRING_LIST | StringList |
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0