Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. emr
  5. Studio

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.emr.Studio

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource schema for AWS::EMR::Studio

    Create Studio Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Studio(name: string, args: StudioArgs, opts?: CustomResourceOptions);
    @overload
def Studio(resource_name: str,
           args: StudioArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Studio(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           auth_mode: Optional[StudioAuthMode] = None,
           default_s3_location: Optional[str] = None,
           workspace_security_group_id: Optional[str] = None,
           vpc_id: Optional[str] = None,
           engine_security_group_id: Optional[str] = None,
           subnet_ids: Optional[Sequence[str]] = None,
           service_role: Optional[str] = None,
           idp_relay_state_parameter_name: Optional[str] = None,
           idp_auth_url: Optional[str] = None,
           name: Optional[str] = None,
           idc_user_assignment: Optional[StudioIdcUserAssignment] = None,
           idc_instance_arn: Optional[str] = None,
           tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
           trusted_identity_propagation_enabled: Optional[bool] = None,
           user_role: Optional[str] = None,
           encryption_key_arn: Optional[str] = None,
           description: Optional[str] = None)
    func NewStudio(ctx *Context, name string, args StudioArgs, opts ...ResourceOption) (*Studio, error)
    public Studio(string name, StudioArgs args, CustomResourceOptions? opts = null)
    public Studio(String name, StudioArgs args)
public Studio(String name, StudioArgs args, CustomResourceOptions options)

    type: aws-native:emr:Studio
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args StudioArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args StudioArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args StudioArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StudioArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StudioArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Studio Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Studio resource accepts the following input properties:

    AuthMode Pulumi.AwsNative.Emr.StudioAuthMode
    Specifies whether the Studio authenticates users using single sign-on (SSO) or IAM. Amazon EMR Studio currently only supports SSO authentication.
    DefaultS3Location string
    The default Amazon S3 location to back up EMR Studio Workspaces and notebook files. A Studio user can select an alternative Amazon S3 location when creating a Workspace.
    EngineSecurityGroupId 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.
    ServiceRole string
    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 List<string>
    A list of up to 5 subnet IDs to associate with the Studio. The subnets must belong to the VPC specified by VpcId. Studio users can create a Workspace in any of the specified subnets.
    VpcId string
    The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
    WorkspaceSecurityGroupId 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.
    Description string
    A detailed description of the Studio.
    EncryptionKeyArn string
    The AWS KMS key identifier (ARN) used to encrypt AWS EMR Studio workspace and notebook files when backed up to AWS S3.
    IdcInstanceArn string
    The ARN of the IAM Identity Center instance to create the Studio application.
    IdcUserAssignment Pulumi.AwsNative.Emr.StudioIdcUserAssignment
    Specifies whether IAM Identity Center user assignment is REQUIRED or OPTIONAL. If the value is set to REQUIRED, users must be explicitly assigned to the Studio application to access the Studio.
    IdpAuthUrl string
    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 string
    The name of relay state parameter for external Identity Provider.
    Name string
    A descriptive name for the Amazon EMR Studio.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    A list of tags to associate with the 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.
    TrustedIdentityPropagationEnabled bool
    A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false.
    UserRole string
    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.
    AuthMode StudioAuthMode
    Specifies whether the Studio authenticates users using single sign-on (SSO) or IAM. Amazon EMR Studio currently only supports SSO authentication.
    DefaultS3Location string
    The default Amazon S3 location to back up EMR Studio Workspaces and notebook files. A Studio user can select an alternative Amazon S3 location when creating a Workspace.
    EngineSecurityGroupId 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.
    ServiceRole string
    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 []string
    A list of up to 5 subnet IDs to associate with the Studio. The subnets must belong to the VPC specified by VpcId. Studio users can create a Workspace in any of the specified subnets.
    VpcId string
    The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
    WorkspaceSecurityGroupId 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.
    Description string
    A detailed description of the Studio.
    EncryptionKeyArn string
    The AWS KMS key identifier (ARN) used to encrypt AWS EMR Studio workspace and notebook files when backed up to AWS S3.
    IdcInstanceArn string
    The ARN of the IAM Identity Center instance to create the Studio application.
    IdcUserAssignment StudioIdcUserAssignment
    Specifies whether IAM Identity Center user assignment is REQUIRED or OPTIONAL. If the value is set to REQUIRED, users must be explicitly assigned to the Studio application to access the Studio.
    IdpAuthUrl string
    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 string
    The name of relay state parameter for external Identity Provider.
    Name string
    A descriptive name for the Amazon EMR Studio.
    Tags TagArgs
    A list of tags to associate with the 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.
    TrustedIdentityPropagationEnabled bool
    A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false.
    UserRole string
    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.
    authMode StudioAuthMode
    Specifies whether the Studio authenticates users using single sign-on (SSO) or IAM. Amazon EMR Studio currently only supports SSO authentication.
    defaultS3Location String
    The default Amazon S3 location to back up EMR Studio Workspaces and notebook files. A Studio user can select an alternative Amazon S3 location when creating a Workspace.
    engineSecurityGroupId 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.
    serviceRole String
    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 List<String>
    A list of up to 5 subnet IDs to associate with the Studio. The subnets must belong to the VPC specified by VpcId. Studio users can create a Workspace in any of the specified subnets.
    vpcId String
    The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
    workspaceSecurityGroupId 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.
    description String
    A detailed description of the Studio.
    encryptionKeyArn String
    The AWS KMS key identifier (ARN) used to encrypt AWS EMR Studio workspace and notebook files when backed up to AWS S3.
    idcInstanceArn String
    The ARN of the IAM Identity Center instance to create the Studio application.
    idcUserAssignment StudioIdcUserAssignment
    Specifies whether IAM Identity Center user assignment is REQUIRED or OPTIONAL. If the value is set to REQUIRED, users must be explicitly assigned to the Studio application to access the Studio.
    idpAuthUrl String
    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 String
    The name of relay state parameter for external Identity Provider.
    name String
    A descriptive name for the Amazon EMR Studio.
    tags List<Tag>
    A list of tags to associate with the 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.
    trustedIdentityPropagationEnabled Boolean
    A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false.
    userRole String
    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.
    authMode StudioAuthMode
    Specifies whether the Studio authenticates users using single sign-on (SSO) or IAM. Amazon EMR Studio currently only supports SSO authentication.
    defaultS3Location string
    The default Amazon S3 location to back up EMR Studio Workspaces and notebook files. A Studio user can select an alternative Amazon S3 location when creating a Workspace.
    engineSecurityGroupId 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.
    serviceRole string
    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 string[]
    A list of up to 5 subnet IDs to associate with the Studio. The subnets must belong to the VPC specified by VpcId. Studio users can create a Workspace in any of the specified subnets.
    vpcId string
    The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
    workspaceSecurityGroupId 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.
    description string
    A detailed description of the Studio.
    encryptionKeyArn string
    The AWS KMS key identifier (ARN) used to encrypt AWS EMR Studio workspace and notebook files when backed up to AWS S3.
    idcInstanceArn string
    The ARN of the IAM Identity Center instance to create the Studio application.
    idcUserAssignment StudioIdcUserAssignment
    Specifies whether IAM Identity Center user assignment is REQUIRED or OPTIONAL. If the value is set to REQUIRED, users must be explicitly assigned to the Studio application to access the Studio.
    idpAuthUrl string
    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 string
    The name of relay state parameter for external Identity Provider.
    name string
    A descriptive name for the Amazon EMR Studio.
    tags Tag[]
    A list of tags to associate with the 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.
    trustedIdentityPropagationEnabled boolean
    A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false.
    userRole string
    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.
    auth_mode StudioAuthMode
    Specifies whether the Studio authenticates users using single sign-on (SSO) or IAM. Amazon EMR Studio currently only supports SSO authentication.
    default_s3_location str
    The default Amazon S3 location to back up EMR Studio Workspaces and notebook files. A Studio user can select an alternative Amazon S3 location when creating a Workspace.
    engine_security_group_id str
    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.
    service_role str
    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.
    subnet_ids Sequence[str]
    A list of up to 5 subnet IDs to associate with the Studio. The subnets must belong to the VPC specified by VpcId. Studio users can create a Workspace in any of the specified subnets.
    vpc_id str
    The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
    workspace_security_group_id str
    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.
    description str
    A detailed description of the Studio.
    encryption_key_arn str
    The AWS KMS key identifier (ARN) used to encrypt AWS EMR Studio workspace and notebook files when backed up to AWS S3.
    idc_instance_arn str
    The ARN of the IAM Identity Center instance to create the Studio application.
    idc_user_assignment StudioIdcUserAssignment
    Specifies whether IAM Identity Center user assignment is REQUIRED or OPTIONAL. If the value is set to REQUIRED, users must be explicitly assigned to the Studio application to access the Studio.
    idp_auth_url str
    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.
    idp_relay_state_parameter_name str
    The name of relay state parameter for external Identity Provider.
    name str
    A descriptive name for the Amazon EMR Studio.
    tags Sequence[TagArgs]
    A list of tags to associate with the 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.
    trusted_identity_propagation_enabled bool
    A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false.
    user_role str
    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.
    authMode "SSO" | "IAM"
    Specifies whether the Studio authenticates users using single sign-on (SSO) or IAM. Amazon EMR Studio currently only supports SSO authentication.
    defaultS3Location String
    The default Amazon S3 location to back up EMR Studio Workspaces and notebook files. A Studio user can select an alternative Amazon S3 location when creating a Workspace.
    engineSecurityGroupId 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.
    serviceRole String
    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 List<String>
    A list of up to 5 subnet IDs to associate with the Studio. The subnets must belong to the VPC specified by VpcId. Studio users can create a Workspace in any of the specified subnets.
    vpcId String
    The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
    workspaceSecurityGroupId 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.
    description String
    A detailed description of the Studio.
    encryptionKeyArn String
    The AWS KMS key identifier (ARN) used to encrypt AWS EMR Studio workspace and notebook files when backed up to AWS S3.
    idcInstanceArn String
    The ARN of the IAM Identity Center instance to create the Studio application.
    idcUserAssignment "REQUIRED" | "OPTIONAL"
    Specifies whether IAM Identity Center user assignment is REQUIRED or OPTIONAL. If the value is set to REQUIRED, users must be explicitly assigned to the Studio application to access the Studio.
    idpAuthUrl String
    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 String
    The name of relay state parameter for external Identity Provider.
    name String
    A descriptive name for the Amazon EMR Studio.
    tags List<Property Map>
    A list of tags to associate with the 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.
    trustedIdentityPropagationEnabled Boolean
    A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false.
    userRole String
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Studio resource produces the following output properties:

    Arn string
    The Amazon Resource Name (ARN) of the EMR Studio.
    Id string
    The provider-assigned unique ID for this managed resource.
    StudioId string
    The ID of the EMR Studio.
    Url string
    The unique Studio access URL.
    Arn string
    The Amazon Resource Name (ARN) of the EMR Studio.
    Id string
    The provider-assigned unique ID for this managed resource.
    StudioId string
    The ID of the EMR Studio.
    Url string
    The unique Studio access URL.
    arn String
    The Amazon Resource Name (ARN) of the EMR Studio.
    id String
    The provider-assigned unique ID for this managed resource.
    studioId String
    The ID of the EMR Studio.
    url String
    The unique Studio access URL.
    arn string
    The Amazon Resource Name (ARN) of the EMR Studio.
    id string
    The provider-assigned unique ID for this managed resource.
    studioId string
    The ID of the EMR Studio.
    url string
    The unique Studio access URL.
    arn str
    The Amazon Resource Name (ARN) of the EMR Studio.
    id str
    The provider-assigned unique ID for this managed resource.
    studio_id str
    The ID of the EMR Studio.
    url str
    The unique Studio access URL.
    arn String
    The Amazon Resource Name (ARN) of the EMR Studio.
    id String
    The provider-assigned unique ID for this managed resource.
    studioId String
    The ID of the EMR Studio.
    url String
    The unique Studio access URL.

    Supporting Types

    StudioAuthMode, StudioAuthModeArgs

    Sso
    SSO
    Iam
    IAM
    StudioAuthModeSso
    SSO
    StudioAuthModeIam
    IAM
    Sso
    SSO
    Iam
    IAM
    Sso
    SSO
    Iam
    IAM
    SSO
    SSO
    IAM
    IAM
    "SSO"
    SSO
    "IAM"
    IAM

    StudioIdcUserAssignment, StudioIdcUserAssignmentArgs

    Required
    REQUIRED
    Optional
    OPTIONAL
    StudioIdcUserAssignmentRequired
    REQUIRED
    StudioIdcUserAssignmentOptional
    OPTIONAL
    Required
    REQUIRED
    Optional
    OPTIONAL
    Required
    REQUIRED
    Optional
    OPTIONAL
    REQUIRED
    REQUIRED
    OPTIONAL
    OPTIONAL
    "REQUIRED"
    REQUIRED
    "OPTIONAL"
    OPTIONAL

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native