Class CfnParameterMixinProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnParameterMixinProps>
- Enclosing interface:
CfnParameterMixinProps
CfnParameterMixinProps-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionallowedPattern(String allowedPattern) Sets the value ofCfnParameterMixinProps.getAllowedPattern()build()Builds the configured instance.Sets the value ofCfnParameterMixinProps.getDataType()description(String description) Sets the value ofCfnParameterMixinProps.getDescription()Sets the value ofCfnParameterMixinProps.getName()Sets the value ofCfnParameterMixinProps.getPolicies()Sets the value ofCfnParameterMixinProps.getTags()Sets the value ofCfnParameterMixinProps.getTier()Sets the value ofCfnParameterMixinProps.getType()Sets the value ofCfnParameterMixinProps.getValue()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
allowedPattern
Sets the value ofCfnParameterMixinProps.getAllowedPattern()- Parameters:
allowedPattern- A regular expression used to validate the parameter value. For example, forStringtypes with values restricted to numbers, you can specify the following:AllowedPattern=^\d+$- Returns:
this
-
dataType
Sets the value ofCfnParameterMixinProps.getDataType()- Parameters:
dataType- The data type of the parameter, such astextoraws:ec2:image. The default istext.- Returns:
this
-
description
Sets the value ofCfnParameterMixinProps.getDescription()- Parameters:
description- Information about the parameter.- Returns:
this
-
name
Sets the value ofCfnParameterMixinProps.getName()- Parameters:
name- 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 Systems Manager . 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/.- Returns:
this
-
policies
Sets the value ofCfnParameterMixinProps.getPolicies()- Parameters:
policies- Information about the policies assigned to a parameter. Assigning parameter policies in the AWS Systems Manager User Guide .- Returns:
this
-
tags
Sets the value ofCfnParameterMixinProps.getTags()- Parameters:
tags- 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.- Returns:
this
-
tier
Sets the value ofCfnParameterMixinProps.getTier()- Parameters:
tier- The parameter tier.- Returns:
this
-
type
Sets the value ofCfnParameterMixinProps.getType()- Parameters:
type- The type of parameter.Parameters of type
SecureStringare not supported by AWS CloudFormation .- Returns:
this
-
value
Sets the value ofCfnParameterMixinProps.getValue()- Parameters:
value- The parameter value.If type is
StringList, the system returns a comma-separated string with no spaces between commas in theValuefield.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnParameterMixinProps>- Returns:
- a new instance of
CfnParameterMixinProps - Throws:
NullPointerException- if any required attribute was not provided
-