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

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

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

    Using getPreferences

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPreferences(args: GetPreferencesArgs, opts?: InvokeOptions): Promise<GetPreferencesResult>
function getPreferencesOutput(args: GetPreferencesOutputArgs, opts?: InvokeOptions): Output<GetPreferencesResult>
    def get_preferences(account_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetPreferencesResult
def get_preferences_output(account_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetPreferencesResult]
    func LookupPreferences(ctx *Context, args *LookupPreferencesArgs, opts ...InvokeOption) (*LookupPreferencesResult, error)
func LookupPreferencesOutput(ctx *Context, args *LookupPreferencesOutputArgs, opts ...InvokeOption) LookupPreferencesResultOutput

    > Note: This function is named LookupPreferences in the Go SDK.

    public static class GetPreferences 
{
    public static Task<GetPreferencesResult> InvokeAsync(GetPreferencesArgs args, InvokeOptions? opts = null)
    public static Output<GetPreferencesResult> Invoke(GetPreferencesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPreferencesResult> getPreferences(GetPreferencesArgs args, InvokeOptions options)
public static Output<GetPreferencesResult> getPreferences(GetPreferencesArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:ssmguiconnect:getPreferences
  arguments:
    # arguments dictionary

    The following arguments are supported:

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

    getPreferences Result

    The following output properties are available:

    AccountId string
    The AWS Account Id that the preference is associated with, used as the unique identifier for this resource.
    ConnectionRecordingPreferences Pulumi.AwsNative.SsmGuiConnect.Outputs.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.
    AccountId string
    The AWS Account Id that the preference is associated with, used as the unique identifier for this resource.
    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.
    accountId String
    The AWS Account Id that the preference is associated with, used as the unique identifier for this resource.
    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.
    accountId string
    The AWS Account Id that the preference is associated with, used as the unique identifier for this resource.
    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.
    account_id str
    The AWS Account Id that the preference is associated with, used as the unique identifier for this resource.
    connection_recording_preferences 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.
    accountId String
    The AWS Account Id that the preference is associated with, used as the unique identifier for this resource.
    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.

    Supporting Types

    ConnectionRecordingPreferencesProperties

    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

    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

    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