interface CfnStudioProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.EMR.CfnStudioProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsemr#CfnStudioProps |
![]() | software.amazon.awscdk.services.emr.CfnStudioProps |
![]() | aws_cdk.aws_emr.CfnStudioProps |
![]() | aws-cdk-lib » aws_emr » CfnStudioProps |
Properties for defining a CfnStudio
.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emr-studio.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_emr as emr } from 'aws-cdk-lib';
const cfnStudioProps: emr.CfnStudioProps = {
authMode: 'authMode',
defaultS3Location: 'defaultS3Location',
engineSecurityGroupId: 'engineSecurityGroupId',
name: 'name',
serviceRole: 'serviceRole',
subnetIds: ['subnetIds'],
vpcId: 'vpcId',
workspaceSecurityGroupId: 'workspaceSecurityGroupId',
// the properties below are optional
description: 'description',
encryptionKeyArn: 'encryptionKeyArn',
idcInstanceArn: 'idcInstanceArn',
idcUserAssignment: 'idcUserAssignment',
idpAuthUrl: 'idpAuthUrl',
idpRelayStateParameterName: 'idpRelayStateParameterName',
tags: [{
key: 'key',
value: 'value',
}],
trustedIdentityPropagationEnabled: false,
userRole: 'userRole',
};
Properties
Name | Type | Description |
---|---|---|
auth | string | Specifies whether the Studio authenticates users using IAM Identity Center or IAM. |
default | string | The Amazon S3 location to back up EMR Studio Workspaces and notebook files. |
engine | string | The ID of the Amazon EMR Studio Engine security group. |
name | string | A descriptive name for the Amazon EMR Studio. |
service | string | The Amazon Resource Name (ARN) of the IAM role that will be assumed by the Amazon EMR Studio. |
subnet | string[] | A list of subnet IDs to associate with the Amazon EMR Studio. |
vpc | string | The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio. |
workspace | string | The ID of the Workspace security group associated with the Amazon EMR Studio. |
description? | string | A detailed description of the Amazon EMR Studio. |
encryption | string | The AWS KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3. |
idc | string | The ARN of the IAM Identity Center instance the Studio application belongs to. |
idc | string | Indicates whether the Studio has REQUIRED or OPTIONAL IAM Identity Center user assignment. |
idp | string | Your identity provider's authentication endpoint. |
idp | string | The name of your identity provider's RelayState parameter. |
tags? | Cfn [] | An array of key-value pairs to apply to this resource. |
trusted | boolean | IResolvable | Indicates whether the Studio has Trusted identity propagation enabled. |
user | string | The Amazon Resource Name (ARN) of the IAM user role that will be assumed by users and groups logged in to a Studio. |
authMode
Type:
string
Specifies whether the Studio authenticates users using IAM Identity Center or IAM.
defaultS3Location
Type:
string
The Amazon S3 location to back up EMR Studio Workspaces and notebook files.
engineSecurityGroupId
Type:
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
.
name
Type:
string
A descriptive name for the Amazon EMR Studio.
serviceRole
Type:
string
The Amazon Resource Name (ARN) of the IAM role that will be assumed by the Amazon EMR Studio.
The service role provides a way for Amazon EMR Studio to interoperate with other AWS services.
subnetIds
Type:
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.
vpcId
Type:
string
The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
workspaceSecurityGroupId
Type:
string
The ID of the Workspace security group associated with the Amazon EMR Studio.
The Workspace security group allows outbound network traffic to resources in the Engine security group and to the internet.
description?
Type:
string
(optional)
A detailed description of the Amazon EMR Studio.
encryptionKeyArn?
Type:
string
(optional)
The AWS KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
idcInstanceArn?
Type:
string
(optional)
The ARN of the IAM Identity Center instance the Studio application belongs to.
idcUserAssignment?
Type:
string
(optional)
Indicates whether the Studio has REQUIRED
or OPTIONAL
IAM Identity Center user assignment.
If the value is set to REQUIRED
, users must be explicitly assigned to the Studio application to access the Studio.
idpAuthUrl?
Type:
string
(optional)
Your identity provider's authentication endpoint.
Amazon EMR Studio redirects federated users to this endpoint for authentication when logging in to a Studio with the Studio URL.
idpRelayStateParameterName?
Type:
string
(optional)
The name of your identity provider's RelayState
parameter.
tags?
Type:
Cfn
[]
(optional)
An array of key-value pairs to apply to this resource.
For more information, see Tag .
trustedIdentityPropagationEnabled?
Type:
boolean |
IResolvable
(optional)
Indicates whether the Studio has Trusted identity propagation enabled.
The default value is false
.
userRole?
Type:
string
(optional)
The Amazon Resource Name (ARN) of the IAM user role that will be assumed by users and groups logged in to a Studio.
The permissions attached to this IAM role can be scoped down for each user or group using session policies. You only need to specify UserRole
when you set AuthMode
to SSO
.