Skip to content

Latest commit

 

History

History
68 lines (59 loc) · 6.11 KB

types.md

File metadata and controls

68 lines (59 loc) · 6.11 KB
Raw

AWS.EMR @ default

Resource AWS.EMR/Studio@default

  • Valid Scope(s): Unknown

Properties

  • alias: string (Required): the resource alias
  • name: string: the resource name
  • properties: AWS.EMR/StudioProperties (Required): properties of the resource

Resource AWS.EMR/StudioSessionMapping@default

  • Valid Scope(s): Unknown

Properties

Resource AWS.EMR/WALWorkspace@default

  • Valid Scope(s): Unknown

Properties

AWS.EMR/StudioProperties

Properties

  • Arn: string (ReadOnly): The Amazon Resource Name (ARN) of the EMR Studio.
  • AuthMode: string (Required): Specifies whether the Studio authenticates users using single sign-on (SSO) or IAM. Amazon EMR Studio currently only supports SSO authentication.
  • DefaultS3Location: string (Required): 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.
  • 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.
  • EngineSecurityGroupId: string (Required): 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.
  • IdcInstanceArn: string: The ARN of the IAM Identity Center instance to create the Studio application.
  • IdcUserAssignment: string: 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 (Required): A descriptive name for the Amazon EMR Studio.
  • ServiceRole: string (Required): 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.
  • StudioId: string (ReadOnly, Identifier): The ID of the EMR Studio.
  • SubnetIds: string[] (Required): 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.
  • 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: bool: A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false.
  • Url: string (ReadOnly): The unique Studio access URL.
  • 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.
  • VpcId: string (Required): The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
  • WorkspaceSecurityGroupId: string (Required): 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.

Tag

Properties

  • Key: string (Required): The key name of the tag. You can specify a value that is 1 to 127 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
  • Value: string (Required): The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

AWS.EMR/StudioSessionMappingProperties

Properties

  • IdentityName: string (Required, Identifier): The name of the user or group. For more information, see UserName and DisplayName in the AWS SSO Identity Store API Reference. Either IdentityName or IdentityId must be specified.
  • IdentityType: string (Required, Identifier): Specifies whether the identity to map to the Studio is a user or a group.
  • SessionPolicyArn: string (Required): The Amazon Resource Name (ARN) for the session policy that will be applied to the user or group. Session policies refine Studio user permissions without the need to use multiple IAM user roles.
  • StudioId: string (Required, Identifier): The ID of the Amazon EMR Studio to which the user or group will be mapped.

AWS.EMR/WALWorkspaceProperties

Properties

  • Tags: Tag[]: An array of key-value pairs to apply to this resource.
  • WALWorkspaceName: string (Identifier): The name of the emrwal container

Tag

Properties

  • Key: string (Required): The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
  • Value: string (Required): The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.