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< subnetIds, Input<String> >Map< ? tags, Input<String, String> ?>String?> ? userRole, required Input<String> vpcId, required Input<String> workspaceSecurityGroupId}) -
Creates a new StudioArgs.
authModeSpecifies whether the Studio authenticates users using IAM or Amazon Web Services SSO. Valid values areSSOorIAM.defaultS3LocationThe Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.descriptionA detailed description of the Amazon EMR Studio.encryptionKeyArnThe AWS KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.engineSecurityGroupIdThe 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 byvpcId.idpAuthUrlThe 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.idpRelayStateParameterNameThe 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.nameA descriptive name for the Amazon EMR Studio.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.serviceRoleThe 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.subnetIdsA 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 byvpcId. Studio users can create a Workspace in any of the specified subnets.tagslist of tags to apply to the EMR Cluster. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.userRoleThe 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.vpcIdID of the VPC to associate with the Studio.workspaceSecurityGroupIdThe 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 byvpcId.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
SSOorIAM.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 -
list of tags to apply to the EMR Cluster. If configured with a provider
defaultTagsconfiguration 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