class CfnStudio (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.EMR.CfnStudio |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsemr#CfnStudio |
![]() | software.amazon.awscdk.services.emr.CfnStudio |
![]() | aws_cdk.aws_emr.CfnStudio |
![]() | aws-cdk-lib » aws_emr » CfnStudio |
Implements
IConstruct
, IDependable
, IInspectable
, ITaggable
The AWS::EMR::Studio
resource specifies an Amazon EMR Studio.
An EMR Studio is a web-based, integrated development environment for fully managed Jupyter notebooks that run on Amazon EMR clusters. For more information, see the Amazon EMR Management Guide .
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 cfnStudio = new emr.CfnStudio(this, 'MyCfnStudio', {
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',
});
Initializer
new CfnStudio(scope: Construct, id: string, props: CfnStudioProps)
Parameters
- scope
Construct
— Scope in which this resource is defined. - id
string
— Construct identifier for this resource (unique in its scope). - props
Cfn
— Resource properties.Studio Props
Construct Props
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
.
Properties
Name | Type | Description |
---|---|---|
attr | string | The Amazon Resource Name (ARN) of the Amazon EMR Studio. |
attr | string | The ID of the Amazon EMR Studio. |
attr | string | The unique access URL of the Amazon EMR Studio. |
auth | string | Specifies whether the Studio authenticates users using IAM Identity Center or IAM. |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
creation | string[] | |
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. |
logical | string | The logical ID for this CloudFormation stack element. |
name | string | A descriptive name for the Amazon EMR Studio. |
node | Node | The tree node. |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
service | string | The Amazon Resource Name (ARN) of the IAM role that will be assumed by the Amazon EMR Studio. |
stack | Stack | The stack in which this element is defined. |
subnet | string[] | A list of subnet IDs to associate with the Amazon EMR Studio. |
tags | Tag | Tag Manager which manages the tags for this resource. |
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. |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
attrArn
Type:
string
The Amazon Resource Name (ARN) of the Amazon EMR Studio.
For example: arn:aws:elasticmapreduce:us-east-1:653XXXXXXXXX:studio/es-EXAMPLE12345678XXXXXXXXXXX
.
attrStudioId
Type:
string
The ID of the Amazon EMR Studio.
For example: es-EXAMPLE12345678XXXXXXXXXXX
.
attrUrl
Type:
string
The unique access URL of the Amazon EMR Studio.
For example: https://es-EXAMPLE12345678XXXXXXXXXXX.emrstudio-prod.us-east-1.amazonaws.com
.
authMode
Type:
string
Specifies whether the Studio authenticates users using IAM Identity Center or IAM.
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
creationStack
Type:
string[]
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.
logicalId
Type:
string
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId)
.
name
Type:
string
A descriptive name for the Amazon EMR Studio.
node
Type:
Node
The tree node.
ref
Type:
string
Return a string that will be resolved to a CloudFormation { Ref }
for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could
coerce it to an IResolvable through Lazy.any({ produce: resource.ref })
.
serviceRole
Type:
string
The Amazon Resource Name (ARN) of the IAM role that will be assumed by the Amazon EMR Studio.
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
subnetIds
Type:
string[]
A list of subnet IDs to associate with the Amazon EMR Studio.
tags
Type:
Tag
Tag Manager which manages the tags for this resource.
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.
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.
idpAuthUrl?
Type:
string
(optional)
Your identity provider's authentication endpoint.
idpRelayStateParameterName?
Type:
string
(optional)
The name of your identity provider's RelayState
parameter.
tagsRaw?
Type:
Cfn
[]
(optional)
An array of key-value pairs to apply to this resource.
trustedIdentityPropagationEnabled?
Type:
boolean |
IResolvable
(optional)
Indicates whether the Studio has Trusted identity propagation enabled.
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.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
obtain | Retrieves an array of resources this resource depends on. |
obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
override | Overrides the auto-generated logical ID with a specific ID. |
remove | Indicates that this resource no longer depends on another resource. |
replace | Replaces one dependency with another. |
to | Returns a string representation of this construct. |
protected render |
addDeletionOverride(path)
public addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
addDependency(target)
public addDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
addDependsOn(target)
public addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)
public addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
addOverride(path, value)
public addOverride(path: string, value: any): void
Parameters
- path
string
— - The path of the property, you can use dot notation to override values in complex types. - value
any
— - The value.
Adds an override to the synthesized CloudFormation resource.
To add a
property override, either use addPropertyOverride
or prefix path
with
"Properties." (i.e. Properties.TopicName
).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal .
in the property name, prefix with a \
. In most
programming languages you will need to write this as "\\."
because the
\
itself will need to be escaped.
For example,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value
argument to addOverride
will not be processed or translated
in any way. Pass raw JSON values in here with the correct capitalization
for CloudFormation. If you pass CDK classes or structs, they will be
rendered with lowercased key names, and CloudFormation will reject the
template.
addPropertyDeletionOverride(propertyPath)
public addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string
— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)
public addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string
— The path of the property. - value
any
— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
applyRemovalPolicy(policy?, options?)
public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
Removal
Policy - options
Removal
Policy Options
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT
). A list of resources that support this policy
can be found in the following link:
getAtt(attributeName, typeHint?)
public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string
— The name of the attribute. - typeHint
Resolution
Type Hint
Returns
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn
), but this can be used for future compatibility
in case there is no generated attribute.
getMetadata(key)
public getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
inspect(inspector)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree
— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
obtainDependencies()
public obtainDependencies(): Stack | CfnResource[]
Returns
Stack
|
Cfn
Resource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
obtainResourceDependencies()
public obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)
public overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string
— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)
public removeDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target, newTarget)
public replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn
— The dependency to replace.Resource - newTarget
Cfn
— The new dependency to add.Resource
Replaces one dependency with another.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
protected renderProperties(props)
protected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }