Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. ssmguiconnect
  5. Preferences

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.28.0 published on Monday, May 19, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.ssmguiconnect.Preferences

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.28.0 published on Monday, May 19, 2025 by Pulumi
pulumi/pulumi-aws-native

    Definition of AWS::SSMGuiConnect::Preferences Resource Type

    Create Preferences Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Preferences(name: string, args?: PreferencesArgs, opts?: CustomResourceOptions);
    @overload
def Preferences(resource_name: str,
                args: Optional[PreferencesArgs] = None,
                opts: Optional[ResourceOptions] = None)

@overload
def Preferences(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                connection_recording_preferences: Optional[ConnectionRecordingPreferencesPropertiesArgs] = None)
    func NewPreferences(ctx *Context, name string, args *PreferencesArgs, opts ...ResourceOption) (*Preferences, error)
    public Preferences(string name, PreferencesArgs? args = null, CustomResourceOptions? opts = null)
    public Preferences(String name, PreferencesArgs args)
public Preferences(String name, PreferencesArgs args, CustomResourceOptions options)

    type: aws-native:ssmguiconnect:Preferences
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PreferencesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PreferencesArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PreferencesArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PreferencesArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PreferencesArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Preferences Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Preferences resource accepts the following input properties:

    ConnectionRecordingPreferences Pulumi.AwsNative.SsmGuiConnect.Inputs.ConnectionRecordingPreferencesProperties
    The set of preferences used for recording RDP connections in the requesting AWS account and AWS Region. This includes details such as which S3 bucket recordings are stored in.
    ConnectionRecordingPreferences ConnectionRecordingPreferencesPropertiesArgs
    The set of preferences used for recording RDP connections in the requesting AWS account and AWS Region. This includes details such as which S3 bucket recordings are stored in.
    connectionRecordingPreferences ConnectionRecordingPreferencesProperties
    The set of preferences used for recording RDP connections in the requesting AWS account and AWS Region. This includes details such as which S3 bucket recordings are stored in.
    connectionRecordingPreferences ConnectionRecordingPreferencesProperties
    The set of preferences used for recording RDP connections in the requesting AWS account and AWS Region. This includes details such as which S3 bucket recordings are stored in.
    connection_recording_preferences ConnectionRecordingPreferencesPropertiesArgs
    The set of preferences used for recording RDP connections in the requesting AWS account and AWS Region. This includes details such as which S3 bucket recordings are stored in.
    connectionRecordingPreferences Property Map
    The set of preferences used for recording RDP connections in the requesting AWS account and AWS Region. This includes details such as which S3 bucket recordings are stored in.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Preferences resource produces the following output properties:

    AccountId string
    The AWS Account Id that the preference is associated with, used as the unique identifier for this resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    AccountId string
    The AWS Account Id that the preference is associated with, used as the unique identifier for this resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    accountId String
    The AWS Account Id that the preference is associated with, used as the unique identifier for this resource.
    id String
    The provider-assigned unique ID for this managed resource.
    accountId string
    The AWS Account Id that the preference is associated with, used as the unique identifier for this resource.
    id string
    The provider-assigned unique ID for this managed resource.
    account_id str
    The AWS Account Id that the preference is associated with, used as the unique identifier for this resource.
    id str
    The provider-assigned unique ID for this managed resource.
    accountId String
    The AWS Account Id that the preference is associated with, used as the unique identifier for this resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    ConnectionRecordingPreferencesProperties, ConnectionRecordingPreferencesPropertiesArgs

    KmsKeyArn string
    The ARN of a AWS KMS key that is used to encrypt data while it is being processed by the service. This key must exist in the same AWS Region as the node you start an RDP connection to.
    RecordingDestinations Pulumi.AwsNative.SsmGuiConnect.Inputs.PreferencesRecordingDestinations
    Determines where recordings of RDP connections are stored.
    KmsKeyArn string
    The ARN of a AWS KMS key that is used to encrypt data while it is being processed by the service. This key must exist in the same AWS Region as the node you start an RDP connection to.
    RecordingDestinations PreferencesRecordingDestinations
    Determines where recordings of RDP connections are stored.
    kmsKeyArn String
    The ARN of a AWS KMS key that is used to encrypt data while it is being processed by the service. This key must exist in the same AWS Region as the node you start an RDP connection to.
    recordingDestinations PreferencesRecordingDestinations
    Determines where recordings of RDP connections are stored.
    kmsKeyArn string
    The ARN of a AWS KMS key that is used to encrypt data while it is being processed by the service. This key must exist in the same AWS Region as the node you start an RDP connection to.
    recordingDestinations PreferencesRecordingDestinations
    Determines where recordings of RDP connections are stored.
    kms_key_arn str
    The ARN of a AWS KMS key that is used to encrypt data while it is being processed by the service. This key must exist in the same AWS Region as the node you start an RDP connection to.
    recording_destinations PreferencesRecordingDestinations
    Determines where recordings of RDP connections are stored.
    kmsKeyArn String
    The ARN of a AWS KMS key that is used to encrypt data while it is being processed by the service. This key must exist in the same AWS Region as the node you start an RDP connection to.
    recordingDestinations Property Map
    Determines where recordings of RDP connections are stored.

    PreferencesRecordingDestinations, PreferencesRecordingDestinationsArgs

    S3Buckets List<Pulumi.AwsNative.SsmGuiConnect.Inputs.PreferencesS3Bucket>
    The S3 bucket where RDP connection recordings are stored.
    S3Buckets []PreferencesS3Bucket
    The S3 bucket where RDP connection recordings are stored.
    s3Buckets List<PreferencesS3Bucket>
    The S3 bucket where RDP connection recordings are stored.
    s3Buckets PreferencesS3Bucket[]
    The S3 bucket where RDP connection recordings are stored.
    s3_buckets Sequence[PreferencesS3Bucket]
    The S3 bucket where RDP connection recordings are stored.
    s3Buckets List<Property Map>
    The S3 bucket where RDP connection recordings are stored.

    PreferencesS3Bucket, PreferencesS3BucketArgs

    BucketName string
    BucketOwner string
    BucketName string
    BucketOwner string
    bucketName String
    bucketOwner String
    bucketName string
    bucketOwner string
    bucketName String
    bucketOwner String

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.28.0 published on Monday, May 19, 2025 by Pulumi
    pulumi/pulumi-aws-native