Package software.amazon.awscdk.services.ssmguiconnect

Class CfnPreferences

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.ssmguiconnect.CfnPreferences
All Implemented Interfaces:
IInspectable, IPreferencesRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:47.685Z") @Stability(Stable) public class CfnPreferences extends CfnResource implements IInspectable, IPreferencesRef
Specify new or changed connection recording preferences for your AWS Systems Manager GUI Connect connections.

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.ssmguiconnect.*;
 CfnPreferences cfnPreferences = CfnPreferences.Builder.create(this, "MyCfnPreferences")
         .connectionRecordingPreferences(ConnectionRecordingPreferencesProperty.builder()
                 .kmsKeyArn("kmsKeyArn")
                 .recordingDestinations(RecordingDestinationsProperty.builder()
                         .s3Buckets(List.of(S3BucketProperty.builder()
                                 .bucketName("bucketName")
                                 .bucketOwner("bucketOwner")
                                 .build()))
                         .build())
                 .build())
         .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

    • CfnPreferences

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

    • CfnPreferences

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

    • CfnPreferences

      @Stability(Stable) public CfnPreferences(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable CfnPreferencesProps props)
      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.

    • CfnPreferences

      @Stability(Stable) public CfnPreferences(@NotNull software.constructs.Construct scope, @NotNull String id)
      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

    • 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.

    • getAttrAccountId

      @Stability(Stable) @NotNull public String getAttrAccountId()
      The primary identifier for the AWS CloudFormation resource.

    • getCfnProperties

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

    • getPreferencesRef

      @Stability(Stable) @NotNull public PreferencesReference getPreferencesRef()
      A reference to a Preferences resource.
      Specified by:
      getPreferencesRef in interface IPreferencesRef

    • getConnectionRecordingPreferences

      @Stability(Stable) @Nullable public Object getConnectionRecordingPreferences()
      The set of preferences used for recording RDP connections in the requesting AWS account and AWS Region .

      Returns union: either IResolvable or CfnPreferences.ConnectionRecordingPreferencesProperty

    • setConnectionRecordingPreferences

      @Stability(Stable) public void setConnectionRecordingPreferences(@Nullable IResolvable value)
      The set of preferences used for recording RDP connections in the requesting AWS account and AWS Region .

    • setConnectionRecordingPreferences

      @Stability(Stable) public void setConnectionRecordingPreferences(@Nullable CfnPreferences.ConnectionRecordingPreferencesProperty value)
      The set of preferences used for recording RDP connections in the requesting AWS account and AWS Region .