Package software.amazon.awscdk.services.ssm

Class CfnParameter.Builder

java.lang.Object

software.amazon.awscdk.services.ssm.CfnParameter.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnParameter>

Enclosing class:

CfnParameter

@Stability(Stable)
public static final class CfnParameter.Builder
extends Object
implements software.amazon.jsii.Builder<CfnParameter>

A fluent builder for CfnParameter.

Method Summary

Modifier and Type	Method	Description
CfnParameter.Builder	allowedPattern(String allowedPattern)	A regular expression used to validate the parameter value.
CfnParameter	build()
static CfnParameter.Builder	create(software.constructs.Construct scope, String id)
CfnParameter.Builder	dataType(String dataType)	The data type of the parameter, such as text or aws:ec2:image .
CfnParameter.Builder	description(String description)	Information about the parameter.
CfnParameter.Builder	name(String name)	The name of the parameter.
CfnParameter.Builder	policies(String policies)	Information about the policies assigned to a parameter.
CfnParameter.Builder	tags(Map<String,String> tags)	Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs).
CfnParameter.Builder	tier(String tier)	The parameter tier.
CfnParameter.Builder	type(String type)	The type of parameter.
CfnParameter.Builder	value(String value)	The parameter value.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnParameter.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnParameter.Builder.

type

@Stability(Stable)
public CfnParameter.Builder type(String type)

The type of parameter.

Parameters of type SecureString are not supported by AWS CloudFormation .

Parameters:

type - The type of parameter. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-type

value

@Stability(Stable)
public CfnParameter.Builder value(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.

Parameters:

value - The parameter value. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-value

allowedPattern

@Stability(Stable)
public CfnParameter.Builder allowedPattern(String allowedPattern)

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+$

Parameters:

allowedPattern - A regular expression used to validate the parameter value. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-allowedpattern

dataType

@Stability(Stable)
public CfnParameter.Builder dataType(String dataType)

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

The default is text .

Parameters:

dataType - The data type of the parameter, such as text or aws:ec2:image . This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-datatype

description

@Stability(Stable)
public CfnParameter.Builder description(String description)

Information about the parameter.

Parameters:

description - Information about the parameter. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-description

name

@Stability(Stable)
public CfnParameter.Builder name(String name)

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 Amazon Resource Name (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

Parameters:

name - The name of the parameter. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-name

policies

@Stability(Stable)
public CfnParameter.Builder policies(String policies)

Information about the policies assigned to a parameter.

Assigning parameter policies in the AWS Systems Manager User Guide .

Parameters:

policies - Information about the policies assigned to a parameter. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-policies

tags

@Stability(Stable)
public CfnParameter.Builder tags(Map<String,String> 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.

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-tags

tier

@Stability(Stable)
public CfnParameter.Builder tier(String tier)

The parameter tier.

Parameters:

tier - The parameter tier. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-parameter.html#cfn-ssm-parameter-tier

build

@Stability(Stable)
public CfnParameter build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnParameter>

Returns:

a newly built instance of CfnParameter.