Class: Aws::NimbleStudio::Types::CreateStudioRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb

Overview

Note:

When making an API call, you may pass CreateStudioRequest data as a hash:

{
  admin_role_arn: "String", # required
  client_token: "ClientToken",
  display_name: "SyntheticCreateStudioRequestStudioDisplayName", # required
  studio_encryption_configuration: {
    key_arn: "StudioEncryptionConfigurationKeyArn",
    key_type: "AWS_OWNED_KEY", # required, accepts AWS_OWNED_KEY, CUSTOMER_MANAGED_KEY
  },
  studio_name: "StudioName", # required
  tags: {
    "String" => "String",
  },
  user_role_arn: "String", # required
}

Constant Summary collapse

SENSITIVE =
[:display_name]

Instance Attribute Summary collapse

Instance Attribute Details

#admin_role_arnString

The IAM role that Studio Admins will assume when logging in to the Nimble Studio portal.

Returns:

  • (String)


714
715
716
717
718
719
720
721
722
723
724
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 714

class CreateStudioRequest < Struct.new(
  :admin_role_arn,
  :client_token,
  :display_name,
  :studio_encryption_configuration,
  :studio_name,
  :tags,
  :user_role_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#client_tokenString

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the AWS SDK automatically generates a client token and uses it for the request to ensure idempotency.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


714
715
716
717
718
719
720
721
722
723
724
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 714

class CreateStudioRequest < Struct.new(
  :admin_role_arn,
  :client_token,
  :display_name,
  :studio_encryption_configuration,
  :studio_name,
  :tags,
  :user_role_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#display_nameString

A friendly name for the studio.

Returns:

  • (String)


714
715
716
717
718
719
720
721
722
723
724
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 714

class CreateStudioRequest < Struct.new(
  :admin_role_arn,
  :client_token,
  :display_name,
  :studio_encryption_configuration,
  :studio_name,
  :tags,
  :user_role_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#studio_encryption_configurationTypes::StudioEncryptionConfiguration

The studio encryption configuration.



714
715
716
717
718
719
720
721
722
723
724
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 714

class CreateStudioRequest < Struct.new(
  :admin_role_arn,
  :client_token,
  :display_name,
  :studio_encryption_configuration,
  :studio_name,
  :tags,
  :user_role_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#studio_nameString

The studio name that is used in the URL of the Nimble Studio portal when accessed by Nimble Studio users.

Returns:

  • (String)


714
715
716
717
718
719
720
721
722
723
724
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 714

class CreateStudioRequest < Struct.new(
  :admin_role_arn,
  :client_token,
  :display_name,
  :studio_encryption_configuration,
  :studio_name,
  :tags,
  :user_role_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#tagsHash<String,String>

A collection of labels, in the form of key:value pairs, that apply to this resource.

Returns:

  • (Hash<String,String>)


714
715
716
717
718
719
720
721
722
723
724
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 714

class CreateStudioRequest < Struct.new(
  :admin_role_arn,
  :client_token,
  :display_name,
  :studio_encryption_configuration,
  :studio_name,
  :tags,
  :user_role_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end

#user_role_arnString

The IAM role that Studio Users will assume when logging in to the Nimble Studio portal.

Returns:

  • (String)


714
715
716
717
718
719
720
721
722
723
724
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/types.rb', line 714

class CreateStudioRequest < Struct.new(
  :admin_role_arn,
  :client_token,
  :display_name,
  :studio_encryption_configuration,
  :studio_name,
  :tags,
  :user_role_arn)
  SENSITIVE = [:display_name]
  include Aws::Structure
end