Package software.amazon.awscdk.services.ssm

Class IStringParameter.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.ssm.IStringParameter.Jsii$Proxy

All Implemented Interfaces:

IConstruct, IConstruct.Jsii$Default, IDependable, IDependable.Jsii$Default, IResource, IResource.Jsii$Default, IParameter, IParameter.Jsii$Default, IStringParameter, IStringParameter.Jsii$Default, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default

Enclosing interface:

IStringParameter

@Internal
public static final class IStringParameter.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements IStringParameter.Jsii$Default

A proxy class which represents a concrete javascript instance of this type.

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default, IConstruct.Jsii$Proxy

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.amazon.awscdk.core.IDependable

IDependable.Jsii$Default, IDependable.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.core.IResource

IResource.Jsii$Default, IResource.Jsii$Proxy

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

IStringParameter.Jsii$Default, IStringParameter.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
final void	applyRemovalPolicy(RemovalPolicy policy)	Apply the given removal policy to this resource.
final ResourceEnvironment	getEnv()	The environment this resource belongs to.
final ConstructNode	getNode()	The construct tree node for this construct.
final String	getParameterArn()	The ARN of the SSM Parameter resource.
final String	getParameterName()	The name of the SSM Parameter resource.
final String	getParameterType()	The type of the SSM Parameter resource.
final Stack	getStack()	The stack in which this resource is defined.
final String	getStringValue()	The parameter value.
final Grant	grantRead(IGrantable grantee)	Grants read (DescribeParameter, GetParameter, GetParameterHistory) permissions on the SSM Parameter.
final Grant	grantWrite(IGrantable grantee)	Grants write (PutParameter) permissions on the SSM Parameter.

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Method Details

getNode

@Stability(Stable)
@NotNull
public final ConstructNode getNode()

The construct tree node for this construct.

Specified by:

getNode in interface IConstruct

Specified by:

getNode in interface IConstruct.Jsii$Default

Specified by:

getNode in interface IParameter.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

Specified by:

getNode in interface IStringParameter.Jsii$Default

getEnv

@Stability(Stable)
@NotNull
public final ResourceEnvironment getEnv()

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Specified by:

getEnv in interface IParameter.Jsii$Default

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

Specified by:

getEnv in interface IStringParameter.Jsii$Default

getStack

@Stability(Stable)
@NotNull
public final 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

Specified by:

getStack in interface IStringParameter.Jsii$Default

getParameterArn

@Stability(Stable)
@NotNull
public final String getParameterArn()

The ARN of the SSM Parameter resource.

Specified by:

getParameterArn in interface IParameter

Specified by:

getParameterArn in interface IParameter.Jsii$Default

Specified by:

getParameterArn in interface IStringParameter.Jsii$Default

getParameterName

@Stability(Stable)
@NotNull
public final String getParameterName()

The name of the SSM Parameter resource.

Specified by:

getParameterName in interface IParameter

Specified by:

getParameterName in interface IParameter.Jsii$Default

Specified by:

getParameterName in interface IStringParameter.Jsii$Default

getParameterType

@Stability(Stable)
@NotNull
public final String getParameterType()

The type of the SSM Parameter resource.

Specified by:

getParameterType in interface IParameter

Specified by:

getParameterType in interface IParameter.Jsii$Default

Specified by:

getParameterType in interface IStringParameter.Jsii$Default

getStringValue

@Stability(Stable)
@NotNull
public final String getStringValue()

The parameter value.

Value must not nest another parameter. Do not use {{}} in the value.

Specified by:

getStringValue in interface IStringParameter

Specified by:

getStringValue in interface IStringParameter.Jsii$Default

applyRemovalPolicy

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

Specified by:

applyRemovalPolicy in interface IStringParameter.Jsii$Default

Parameters:

policy - This parameter is required.

grantRead

@Stability(Stable)
@NotNull
public final Grant grantRead(@NotNull
 IGrantable grantee)

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

Specified by:

grantRead in interface IParameter

Specified by:

grantRead in interface IParameter.Jsii$Default

Specified by:

grantRead in interface IStringParameter.Jsii$Default

Parameters:

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

grantWrite

@Stability(Stable)
@NotNull
public final 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

Specified by:

grantWrite in interface IStringParameter.Jsii$Default

Parameters:

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