Interface IParameter.Jsii$Default
- All Superinterfaces:
software.constructs.IConstruct
,software.constructs.IConstruct.Jsii$Default
,software.constructs.IDependable
,software.constructs.IDependable.Jsii$Default
,IParameter
,IResource
,IResource.Jsii$Default
,software.amazon.jsii.JsiiSerializable
- All Known Subinterfaces:
IStringListParameter.Jsii$Default
,IStringParameter.Jsii$Default
- All Known Implementing Classes:
IParameter.Jsii$Proxy
,IStringListParameter.Jsii$Proxy
,IStringParameter.Jsii$Proxy
- Enclosing interface:
IParameter
IParameter
.-
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.services.ssm.IParameter
IParameter.Jsii$Default, IParameter.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default, IResource.Jsii$Proxy
-
Method Summary
Modifier and TypeMethodDescriptiondefault 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
The ARN of the SSM Parameter resource.default String
The name of the SSM Parameter resource.default String
The type of the SSM Parameter resource.default Stack
getStack()
The stack in which this resource is defined.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 interfacesoftware.constructs.IConstruct
- Specified by:
getNode
in interfacesoftware.constructs.IConstruct.Jsii$Default
- Specified by:
getNode
in interfaceIResource.Jsii$Default
-
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 interfaceIResource
- Specified by:
getEnv
in interfaceIResource.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStack
in interfaceIResource
- Specified by:
getStack
in interfaceIResource.Jsii$Default
-
getParameterArn
The ARN of the SSM Parameter resource.- Specified by:
getParameterArn
in interfaceIParameter
-
getParameterName
The name of the SSM Parameter resource.- Specified by:
getParameterName
in interfaceIParameter
-
getParameterType
The type of the SSM Parameter resource.- Specified by:
getParameterType
in interfaceIParameter
-
applyRemovalPolicy
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 interfaceIResource
- Specified by:
applyRemovalPolicy
in interfaceIResource.Jsii$Default
- Parameters:
policy
- This parameter is required.
-
grantRead
Grants read (DescribeParameter, GetParameters, GetParameter, GetParameterHistory) permissions on the SSM Parameter.- Specified by:
grantRead
in interfaceIParameter
- Parameters:
grantee
- the role to be granted read-only access to the parameter. This parameter is required.
-
grantWrite
Grants write (PutParameter) permissions on the SSM Parameter.- Specified by:
grantWrite
in interfaceIParameter
- Parameters:
grantee
- the role to be granted write access to the parameter. This parameter is required.
-