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

Class CfnParameterMixinProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnParameterMixinProps>

Enclosing interface:

CfnParameterMixinProps

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

A builder for CfnParameterMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnParameterMixinProps.Builder	allowedPattern(String allowedPattern)	Sets the value of CfnParameterMixinProps.getAllowedPattern()
CfnParameterMixinProps	build()	Builds the configured instance.
CfnParameterMixinProps.Builder	dataType(String dataType)	Sets the value of CfnParameterMixinProps.getDataType()
CfnParameterMixinProps.Builder	description(String description)	Sets the value of CfnParameterMixinProps.getDescription()
CfnParameterMixinProps.Builder	name(String name)	Sets the value of CfnParameterMixinProps.getName()
CfnParameterMixinProps.Builder	policies(String policies)	Sets the value of CfnParameterMixinProps.getPolicies()
CfnParameterMixinProps.Builder	tags(Map<String,String> tags)	Sets the value of CfnParameterMixinProps.getTags()
CfnParameterMixinProps.Builder	tier(String tier)	Sets the value of CfnParameterMixinProps.getTier()
CfnParameterMixinProps.Builder	type(String type)	Sets the value of CfnParameterMixinProps.getType()
CfnParameterMixinProps.Builder	value(String value)	Sets the value of CfnParameterMixinProps.getValue()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

allowedPattern

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

Sets the value of CfnParameterMixinProps.getAllowedPattern()

Parameters:

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

Returns:

this

dataType

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

Sets the value of CfnParameterMixinProps.getDataType()

Parameters:

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

Returns:

this

description

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

Sets the value of CfnParameterMixinProps.getDescription()

Parameters:

description - Information about the parameter.

Returns:

this

name

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

Sets the value of CfnParameterMixinProps.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

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

Sets the value of CfnParameterMixinProps.getPolicies()

Parameters:

policies - Information about the policies assigned to a parameter. Assigning parameter policies in the AWS Systems Manager User Guide .

Returns:

this

tags

@Stability(Stable)
public CfnParameterMixinProps.Builder tags(Map<String,String> tags)

Sets the value of CfnParameterMixinProps.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

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

Sets the value of CfnParameterMixinProps.getTier()

Parameters:

tier - The parameter tier.

Returns:

this

type

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

Sets the value of CfnParameterMixinProps.getType()

Parameters:

type - The type of parameter.

Parameters of type SecureString are not supported by AWS CloudFormation .

Returns:

this

value

@Stability(Stable)
public CfnParameterMixinProps.Builder value(String value)

Sets the value of CfnParameterMixinProps.getValue()

Parameters:

value - The parameter value.

If type is StringList , the system returns a comma-separated string with no spaces between commas in the Value field.

Returns:

this

build

@Stability(Stable)
public CfnParameterMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnParameterMixinProps

Throws:

NullPointerException - if any required attribute was not provided