StudioArgs class

The set of arguments for Studio. The set of arguments for Studio.

Constructors

StudioArgs({required Input<String> authMode, required Input<String> defaultS3Location, Input<String?>? description, Input<String?>? encryptionKeyArn, required Input<String> engineSecurityGroupId, Input<String?>? idpAuthUrl, Input<String?>? idpRelayStateParameterName, Input<String?>? name, Input<String?>? region, required Input<String> serviceRole, required Input<List<String>> subnetIds, Input<Map<String, String>?>? tags, Input<String?>? userRole, required Input<String> vpcId, required Input<String> workspaceSecurityGroupId})
Creates a new StudioArgs. authMode Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO. Valid values are SSO or IAM. defaultS3Location The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files. description A detailed description of the Amazon EMR Studio. encryptionKeyArn The AWS KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3. engineSecurityGroupId 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. idpAuthUrl 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. idpRelayStateParameterName 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. name A descriptive name for the Amazon EMR Studio. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. serviceRole 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. subnetIds 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. tags list of tags to apply to the EMR Cluster. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. userRole The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a User Role when you use Amazon Web Services SSO authentication. The permissions attached to the User Role can be scoped down for each user or group using session policies. vpcId ID of the VPC to associate with the Studio. workspaceSecurityGroupId 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.
const
StudioArgs.fromMap(Map<String, dynamic> map)
factory

Properties

authMode → Input<String>
Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO. Valid values are SSO or IAM.
final
defaultS3Location → Input<String>
The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
final
description → Input<String?>?
A detailed description of the Amazon EMR Studio.
final
encryptionKeyArn → Input<String?>?
The AWS KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
final
engineSecurityGroupId → Input<String>
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.
final
hashCode → int
The hash code for this object.
no setterinherited
idpAuthUrl → Input<String?>?
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.
final
idpRelayStateParameterName → Input<String?>?
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.
final
name → Input<String?>?
A descriptive name for the Amazon EMR Studio.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serviceRole → Input<String>
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.
final
subnetIds → Input<List<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.
final
tags → Input<Map<String, String>?>?
list of tags to apply to the EMR Cluster. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
userRole → Input<String?>?
The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a User Role when you use Amazon Web Services SSO authentication. The permissions attached to the User Role can be scoped down for each user or group using session policies.
final
vpcId → Input<String>
ID of the VPC to associate with the Studio.
final
workspaceSecurityGroupId → Input<String>
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.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited