Class: Aws::EMR::Types::CreateStudioInput

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

Overview

Note:

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

{
  name: "XmlStringMaxLen256", # required
  description: "XmlStringMaxLen256",
  auth_mode: "SSO", # required, accepts SSO, IAM
  vpc_id: "XmlStringMaxLen256", # required
  subnet_ids: ["String"], # required
  service_role: "XmlString", # required
  user_role: "XmlString",
  workspace_security_group_id: "XmlStringMaxLen256", # required
  engine_security_group_id: "XmlStringMaxLen256", # required
  default_s3_location: "XmlString", # required
  idp_auth_url: "XmlString",
  idp_relay_state_parameter_name: "XmlStringMaxLen256",
  tags: [
    {
      key: "String",
      value: "String",
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auth_modeString

Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO.

Returns:

  • (String)


1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 1511

class CreateStudioInput < Struct.new(
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#default_s3_locationString

The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.

Returns:

  • (String)


1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 1511

class CreateStudioInput < Struct.new(
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A detailed description of the Amazon EMR Studio.

Returns:

  • (String)


1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 1511

class CreateStudioInput < Struct.new(
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#engine_security_group_idString

The ID of the Amazon EMR Studio Engine security group. The Engine security group allows inbound network traffic from the Workspace security group, and it must be in the same VPC specified by VpcId.

Returns:

  • (String)


1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 1511

class CreateStudioInput < Struct.new(
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#idp_auth_urlString

The authentication endpoint of your identity provider (IdP). Specify this value when you use IAM authentication and want to let federated users log in to a Studio with the Studio URL and credentials from your IdP. Amazon EMR Studio redirects users to this endpoint to enter credentials.

Returns:

  • (String)


1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 1511

class CreateStudioInput < Struct.new(
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#idp_relay_state_parameter_nameString

The name that your identity provider (IdP) uses for its RelayState parameter. For example, RelayState or TargetSource. Specify this value when you use IAM authentication and want to let federated users log in to a Studio using the Studio URL. The RelayState parameter differs by IdP.

Returns:

  • (String)


1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 1511

class CreateStudioInput < Struct.new(
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

A descriptive name for the Amazon EMR Studio.

Returns:

  • (String)


1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 1511

class CreateStudioInput < Struct.new(
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#service_roleString

The IAM role that the Amazon EMR Studio assumes. The service role provides a way for Amazon EMR Studio to interoperate with other Amazon Web Services services.

Returns:

  • (String)


1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 1511

class CreateStudioInput < Struct.new(
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_idsArray<String>

A list of subnet IDs to associate with the Amazon EMR Studio. A Studio can have a maximum of 5 subnets. The subnets must belong to the VPC specified by VpcId. Studio users can create a Workspace in any of the specified subnets.

Returns:

  • (Array<String>)


1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 1511

class CreateStudioInput < Struct.new(
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

A list of tags to associate with the Amazon EMR Studio. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters.

Returns:



1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 1511

class CreateStudioInput < Struct.new(
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#user_roleString

The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a UserRole when you use Amazon Web Services SSO authentication. The permissions attached to the UserRole can be scoped down for each user or group using session policies.

Returns:

  • (String)


1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 1511

class CreateStudioInput < Struct.new(
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_idString

The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.

Returns:

  • (String)


1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 1511

class CreateStudioInput < Struct.new(
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_security_group_idString

The ID of the Amazon EMR Studio Workspace security group. The Workspace security group allows outbound network traffic to resources in the Engine security group, and it must be in the same VPC specified by VpcId.

Returns:

  • (String)


1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
# File 'gems/aws-sdk-emr/lib/aws-sdk-emr/types.rb', line 1511

class CreateStudioInput < Struct.new(
  :name,
  :description,
  :auth_mode,
  :vpc_id,
  :subnet_ids,
  :service_role,
  :user_role,
  :workspace_security_group_id,
  :engine_security_group_id,
  :default_s3_location,
  :idp_auth_url,
  :idp_relay_state_parameter_name,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end