Package software.amazon.awscdk.cfnpropertymixins.services.ssm

Class CfnParameterPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.ssm.CfnParameterPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnParameterPropsMixin>

Enclosing class:

CfnParameterPropsMixin

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

A fluent builder for CfnParameterPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnParameterPropsMixin.Builder	allowedPattern(String allowedPattern)	A regular expression used to validate the parameter value.
CfnParameterPropsMixin	build()
static CfnParameterPropsMixin.Builder	create()
static CfnParameterPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnParameterPropsMixin.Builder	dataType(String dataType)	The data type of the parameter, such as text or aws:ec2:image .
CfnParameterPropsMixin.Builder	description(String description)	Information about the parameter.
CfnParameterPropsMixin.Builder	name(String name)	The name of the parameter.
CfnParameterPropsMixin.Builder	policies(String policies)	Information about the policies assigned to a parameter.
CfnParameterPropsMixin.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).
CfnParameterPropsMixin.Builder	tier(String tier)	The parameter tier.
CfnParameterPropsMixin.Builder	type(String type)	The type of parameter.
CfnParameterPropsMixin.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 CfnParameterPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnParameterPropsMixin.Builder.

create

@Stability(Stable)
public static CfnParameterPropsMixin.Builder create()

Returns:

a new instance of CfnParameterPropsMixin.Builder.

allowedPattern

@Stability(Stable)
public CfnParameterPropsMixin.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 CfnParameterPropsMixin.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 CfnParameterPropsMixin.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 CfnParameterPropsMixin.Builder name(String 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/ .

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 CfnParameterPropsMixin.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 CfnParameterPropsMixin.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 CfnParameterPropsMixin.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

type

@Stability(Stable)
public CfnParameterPropsMixin.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 CfnParameterPropsMixin.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

build

@Stability(Stable)
public CfnParameterPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnParameterPropsMixin.