Package software.amazon.awscdk.services.ssm

Class CfnSession

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.ssm.CfnSession
All Implemented Interfaces:
IInspectable, IEnvironmentAware, ISessionRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)", date="2026-08-10T14:51:12.495Z") @Stability(Stable) public class CfnSession extends CfnResource implements IInspectable, ISessionRef
Returns information about a Session Manager session.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ssm.*;
 CfnSession cfnSession = CfnSession.Builder.create(this, "MyCfnSession")
         .reason("reason")
         .target("target")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnSession

      protected CfnSession(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnSession

      protected CfnSession(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnSession

      @Stability(Stable) public CfnSession(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnSessionProps props)
      Create a new AWS::SSM::Session.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnSession

      @Stability(Stable) public CfnSession(@NotNull software.constructs.Construct scope, @NotNull String id)
      Create a new AWS::SSM::Session.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.

  • Method Details

    • arnForSession

      @Stability(Stable) @NotNull public static String arnForSession(@NotNull ISessionRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnSession

      @Stability(Stable) @NotNull public static Boolean isCfnSession(@NotNull Object x)
      Checks whether the given object is a CfnSession.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrAccessType

      @Stability(Stable) @NotNull public String getAttrAccessType()
      The access type for the session.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the session.

    • getAttrOwner

      @Stability(Stable) @NotNull public String getAttrOwner()
      The ID of the Amazon Web Services user that started the session.

    • getAttrSessionId

      @Stability(Stable) @NotNull public String getAttrSessionId()
      The ID of the session.

    • getAttrStartDate

      @Stability(Stable) @NotNull public String getAttrStartDate()
      The date and time, in ISO-8601 Extended format, when the session began.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of the session.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getSessionRef

      @Stability(Stable) @NotNull public SessionReference getSessionRef()
      A reference to a Session resource.
      Specified by:
      getSessionRef in interface ISessionRef

    • getReason

      @Stability(Stable) @Nullable public String getReason()
      The reason for connecting to the instance.

    • setReason

      @Stability(Stable) public void setReason(@Nullable String value)
      The reason for connecting to the instance.

    • getTarget

      @Stability(Stable) @Nullable public String getTarget()
      The managed node to connect to for the session.

    • setTarget

      @Stability(Stable) public void setTarget(@Nullable String value)
      The managed node to connect to for the session.