Package software.amazon.awscdk.services.ssm

Interface IStringListParameter.Jsii$Default

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, IParameter, IParameter.Jsii$Default, IParameterRef, IParameterRef.Jsii$Default, IResource, IResource.Jsii$Default, IStringListParameter, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IStringListParameter.Jsii$Proxy

Enclosing interface:

IStringListParameter

@Internal
public static interface IStringListParameter.Jsii$Default
extends IStringListParameter, IParameter.Jsii$Default

Internal default implementation for IStringListParameter.

Nested Class Summary

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IDependable

software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

IEnvironmentAware.Jsii$Default, IEnvironmentAware.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ssm.IParameter

IParameter.Jsii$Default, IParameter.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.ssm.IParameterRef

IParameterRef.Jsii$Default, IParameterRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default, IResource.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.ssm.IStringListParameter

IStringListParameter.Jsii$Default, IStringListParameter.Jsii$Proxy

Method Summary

Modifier and Type	Method	Description
default void	applyRemovalPolicy(RemovalPolicy policy)	Apply the given removal policy to this resource.
default ResourceEnvironment	getEnv()	The environment this resource belongs to.
default software.constructs.Node	getNode()	The tree node.
default String	getParameterArn()	The ARN of the SSM Parameter resource.
default String	getParameterName()	The name of the SSM Parameter resource.
default ParameterReference	getParameterRef()	(experimental) A reference to a Parameter resource.
default String	getParameterType()	The type of the SSM Parameter resource.
default Stack	getStack()	The stack in which this resource is defined.
default List<String>	getStringListValue()	The parameter value.
default Grant	grantRead(IGrantable grantee)	Grants read (DescribeParameter, GetParameters, GetParameter, GetParameterHistory) permissions on the SSM Parameter.
default Grant	grantWrite(IGrantable grantee)	Grants write (PutParameter) permissions on the SSM Parameter.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getNode

@Stability(Stable)
@NotNull
default software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IParameter

Specified by:

getNode in interface IParameter.Jsii$Default

Specified by:

getNode in interface IParameterRef.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(Stable)
@NotNull
default ResourceEnvironment getEnv()

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Specified by:

getEnv in interface IEnvironmentAware

Specified by:

getEnv in interface IEnvironmentAware.Jsii$Default

Specified by:

getEnv in interface IParameter

Specified by:

getEnv in interface IParameter.Jsii$Default

Specified by:

getEnv in interface IParameterRef.Jsii$Default

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(Stable)
@NotNull
default Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IParameter.Jsii$Default

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getParameterRef

@Stability(Experimental)
@NotNull
default ParameterReference getParameterRef()

(experimental) A reference to a Parameter resource.

Specified by:

getParameterRef in interface IParameter.Jsii$Default

Specified by:

getParameterRef in interface IParameterRef

Specified by:

getParameterRef in interface IParameterRef.Jsii$Default

getParameterArn

@Stability(Stable)
@NotNull
default String getParameterArn()

The ARN of the SSM Parameter resource.

Specified by:

getParameterArn in interface IParameter

Specified by:

getParameterArn in interface IParameter.Jsii$Default

getParameterName

@Stability(Stable)
@NotNull
default String getParameterName()

The name of the SSM Parameter resource.

Specified by:

getParameterName in interface IParameter

Specified by:

getParameterName in interface IParameter.Jsii$Default

getParameterType

@Stability(Stable)
@NotNull
default String getParameterType()

The type of the SSM Parameter resource.

Specified by:

getParameterType in interface IParameter

Specified by:

getParameterType in interface IParameter.Jsii$Default

getStringListValue

@Stability(Stable)
@NotNull
default List<String> getStringListValue()

The parameter value.

Value must not nest another parameter. Do not use {{}} in the value. Values in the array cannot contain commas (,).

Specified by:

getStringListValue in interface IStringListParameter

applyRemovalPolicy

@Stability(Stable)
default void applyRemovalPolicy(@NotNull
 RemovalPolicy policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Specified by:

applyRemovalPolicy in interface IParameter.Jsii$Default

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

grantRead

@Stability(Stable)
@NotNull
default Grant grantRead(@NotNull
 IGrantable grantee)

Grants read (DescribeParameter, GetParameters, GetParameter, GetParameterHistory) permissions on the SSM Parameter.

Specified by:

grantRead in interface IParameter

Specified by:

grantRead in interface IParameter.Jsii$Default

Parameters:

grantee - the role to be granted read-only access to the parameter. This parameter is required.

grantWrite

@Stability(Stable)
@NotNull
default Grant grantWrite(@NotNull
 IGrantable grantee)

Grants write (PutParameter) permissions on the SSM Parameter.

Specified by:

grantWrite in interface IParameter

Specified by:

grantWrite in interface IParameter.Jsii$Default

Parameters:

grantee - the role to be granted write access to the parameter. This parameter is required.