Package software.amazon.awscdk.services.ssm

Interface IParameter.Jsii$Default

All Superinterfaces:
IConstruct, software.constructs.IConstruct, IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Default, IDependable, 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
@Internal public static interface IParameter.Jsii$Default extends IParameter, IResource.Jsii$Default
Internal default implementation for IParameter.

  • Method Details

    • getNode

      @Stability(Stable) @NotNull default 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 IResource.Jsii$Default

    • getEnv

      @Stability(Stable) @NotNull default 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 IResource
      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 IResource
      Specified by:
      getStack in interface IResource.Jsii$Default

    • getParameterArn

      @Stability(Stable) @NotNull default String getParameterArn()
      The ARN of the SSM Parameter resource.
      Specified by:
      getParameterArn in interface IParameter

    • getParameterName

      @Stability(Stable) @NotNull default String getParameterName()
      The name of the SSM Parameter resource.
      Specified by:
      getParameterName in interface IParameter

    • getParameterType

      @Stability(Stable) @NotNull default String getParameterType()
      The type of the SSM Parameter resource.
      Specified by:
      getParameterType in interface IParameter

    • 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 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, GetParameter, GetParameterHistory) permissions on the SSM Parameter.

      Specified by:
      grantRead in interface IParameter
      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
      Parameters:
      grantee - the role to be granted write access to the parameter. This parameter is required.