JavaScript is disabled on your browser.
Skip navigation links

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.
com.amazonaws.services.elasticmapreduce.model

Class CreateStudioRequest

    • Constructor Detail

      • CreateStudioRequest

        public CreateStudioRequest()
    • Method Detail

      • setName

        public void setName(String name)

        A descriptive name for the Amazon EMR Studio.

        Parameters:
        name - A descriptive name for the Amazon EMR Studio.
      • getName

        public String getName()

        A descriptive name for the Amazon EMR Studio.

        Returns:
        A descriptive name for the Amazon EMR Studio.
      • withName

        public CreateStudioRequest withName(String name)

        A descriptive name for the Amazon EMR Studio.

        Parameters:
        name - A descriptive name for the Amazon EMR Studio.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setDescription

        public void setDescription(String description)

        A detailed description of the Amazon EMR Studio.

        Parameters:
        description - A detailed description of the Amazon EMR Studio.
      • getDescription

        public String getDescription()

        A detailed description of the Amazon EMR Studio.

        Returns:
        A detailed description of the Amazon EMR Studio.
      • withDescription

        public CreateStudioRequest withDescription(String description)

        A detailed description of the Amazon EMR Studio.

        Parameters:
        description - A detailed description of the Amazon EMR Studio.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setAuthMode

        public void setAuthMode(String authMode)

        Specifies whether the Studio authenticates users using IAM or IAM Identity Center.

        Parameters:
        authMode - Specifies whether the Studio authenticates users using IAM or IAM Identity Center.
        See Also:
        AuthMode
      • getAuthMode

        public String getAuthMode()

        Specifies whether the Studio authenticates users using IAM or IAM Identity Center.

        Returns:
        Specifies whether the Studio authenticates users using IAM or IAM Identity Center.
        See Also:
        AuthMode
      • withAuthMode

        public CreateStudioRequest withAuthMode(String authMode)

        Specifies whether the Studio authenticates users using IAM or IAM Identity Center.

        Parameters:
        authMode - Specifies whether the Studio authenticates users using IAM or IAM Identity Center.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AuthMode
      • withAuthMode

        public CreateStudioRequest withAuthMode(AuthMode authMode)

        Specifies whether the Studio authenticates users using IAM or IAM Identity Center.

        Parameters:
        authMode - Specifies whether the Studio authenticates users using IAM or IAM Identity Center.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AuthMode
      • setVpcId

        public void setVpcId(String vpcId)

        The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.

        Parameters:
        vpcId - The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
      • getVpcId

        public String getVpcId()

        The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.

        Returns:
        The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
      • withVpcId

        public CreateStudioRequest withVpcId(String vpcId)

        The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.

        Parameters:
        vpcId - The ID of the Amazon Virtual Private Cloud (Amazon VPC) to associate with the Studio.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getSubnetIds

        public List<String> getSubnetIds()

        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.

        Returns:
        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.
      • setSubnetIds

        public void setSubnetIds(Collection<String> subnetIds)

        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.

        Parameters:
        subnetIds - 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.
      • withSubnetIds

        public CreateStudioRequest withSubnetIds(String... subnetIds)

        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.

        NOTE: This method appends the values to the existing list (if any). Use setSubnetIds(java.util.Collection) or withSubnetIds(java.util.Collection) if you want to override the existing values.

        Parameters:
        subnetIds - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • withSubnetIds

        public CreateStudioRequest withSubnetIds(Collection<String> subnetIds)

        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.

        Parameters:
        subnetIds - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setServiceRole

        public void setServiceRole(String serviceRole)

        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.

        Parameters:
        serviceRole - 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.
      • getServiceRole

        public String getServiceRole()

        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.

        Returns:
        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.
      • withServiceRole

        public CreateStudioRequest withServiceRole(String serviceRole)

        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.

        Parameters:
        serviceRole - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setUserRole

        public void setUserRole(String userRole)

        The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a UserRole when you use IAM Identity Center authentication. The permissions attached to the UserRole can be scoped down for each user or group using session policies.

        Parameters:
        userRole - The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a UserRole when you use IAM Identity Center authentication. The permissions attached to the UserRole can be scoped down for each user or group using session policies.
      • getUserRole

        public String getUserRole()

        The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a UserRole when you use IAM Identity Center authentication. The permissions attached to the UserRole can be scoped down for each user or group using session policies.

        Returns:
        The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a UserRole when you use IAM Identity Center authentication. The permissions attached to the UserRole can be scoped down for each user or group using session policies.
      • withUserRole

        public CreateStudioRequest withUserRole(String userRole)

        The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a UserRole when you use IAM Identity Center authentication. The permissions attached to the UserRole can be scoped down for each user or group using session policies.

        Parameters:
        userRole - The IAM user role that users and groups assume when logged in to an Amazon EMR Studio. Only specify a UserRole when you use IAM Identity Center authentication. The permissions attached to the UserRole can be scoped down for each user or group using session policies.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setWorkspaceSecurityGroupId

        public void setWorkspaceSecurityGroupId(String workspaceSecurityGroupId)

        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 .

        Parameters:
        workspaceSecurityGroupId - 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.
      • getWorkspaceSecurityGroupId

        public String getWorkspaceSecurityGroupId()

        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 .

        Returns:
        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.
      • withWorkspaceSecurityGroupId

        public CreateStudioRequest withWorkspaceSecurityGroupId(String workspaceSecurityGroupId)

        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 .

        Parameters:
        workspaceSecurityGroupId - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setEngineSecurityGroupId

        public void setEngineSecurityGroupId(String engineSecurityGroupId)

        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.

        Parameters:
        engineSecurityGroupId - 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.
      • getEngineSecurityGroupId

        public String getEngineSecurityGroupId()

        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.

        Returns:
        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 .
      • withEngineSecurityGroupId

        public CreateStudioRequest withEngineSecurityGroupId(String engineSecurityGroupId)

        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.

        Parameters:
        engineSecurityGroupId - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setDefaultS3Location

        public void setDefaultS3Location(String defaultS3Location)

        The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.

        Parameters:
        defaultS3Location - The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
      • getDefaultS3Location

        public String getDefaultS3Location()

        The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.

        Returns:
        The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
      • withDefaultS3Location

        public CreateStudioRequest withDefaultS3Location(String defaultS3Location)

        The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.

        Parameters:
        defaultS3Location - The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setIdpAuthUrl

        public void setIdpAuthUrl(String idpAuthUrl)

        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.

        Parameters:
        idpAuthUrl - 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.
      • getIdpAuthUrl

        public String getIdpAuthUrl()

        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.

        Returns:
        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.
      • withIdpAuthUrl

        public CreateStudioRequest withIdpAuthUrl(String idpAuthUrl)

        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.

        Parameters:
        idpAuthUrl - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setIdpRelayStateParameterName

        public void setIdpRelayStateParameterName(String idpRelayStateParameterName)

        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.

        Parameters:
        idpRelayStateParameterName - 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.
      • getIdpRelayStateParameterName

        public String getIdpRelayStateParameterName()

        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.

        Returns:
        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.
      • withIdpRelayStateParameterName

        public CreateStudioRequest withIdpRelayStateParameterName(String idpRelayStateParameterName)

        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.

        Parameters:
        idpRelayStateParameterName - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getTags

        public List<Tag> getTags()

        A list of tags to associate with the Amazon EMR 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.

        Returns:
        A list of tags to associate with the Amazon EMR 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.
      • setTags

        public void setTags(Collection<Tag> tags)

        A list of tags to associate with the Amazon EMR 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.

        Parameters:
        tags - A list of tags to associate with the Amazon EMR 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.
      • withTags

        public CreateStudioRequest withTags(Tag... tags)

        A list of tags to associate with the Amazon EMR 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.

        NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

        Parameters:
        tags - A list of tags to associate with the Amazon EMR 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • withTags

        public CreateStudioRequest withTags(Collection<Tag> tags)

        A list of tags to associate with the Amazon EMR 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.

        Parameters:
        tags - A list of tags to associate with the Amazon EMR 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setTrustedIdentityPropagationEnabled

        public void setTrustedIdentityPropagationEnabled(Boolean trustedIdentityPropagationEnabled)

        A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false.

        Parameters:
        trustedIdentityPropagationEnabled - A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false.
      • getTrustedIdentityPropagationEnabled

        public Boolean getTrustedIdentityPropagationEnabled()

        A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false.

        Returns:
        A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false.
      • withTrustedIdentityPropagationEnabled

        public CreateStudioRequest withTrustedIdentityPropagationEnabled(Boolean trustedIdentityPropagationEnabled)

        A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false.

        Parameters:
        trustedIdentityPropagationEnabled - A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • isTrustedIdentityPropagationEnabled

        public Boolean isTrustedIdentityPropagationEnabled()

        A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false.

        Returns:
        A Boolean indicating whether to enable Trusted identity propagation for the Studio. The default value is false.
      • setIdcUserAssignment

        public void setIdcUserAssignment(String idcUserAssignment)

        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.

        Parameters:
        idcUserAssignment - 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.
        See Also:
        IdcUserAssignment
      • getIdcUserAssignment

        public String getIdcUserAssignment()

        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.

        Returns:
        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.
        See Also:
        IdcUserAssignment
      • withIdcUserAssignment

        public CreateStudioRequest withIdcUserAssignment(String idcUserAssignment)

        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.

        Parameters:
        idcUserAssignment - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        IdcUserAssignment
      • withIdcUserAssignment

        public CreateStudioRequest withIdcUserAssignment(IdcUserAssignment idcUserAssignment)

        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.

        Parameters:
        idcUserAssignment - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        IdcUserAssignment
      • setIdcInstanceArn

        public void setIdcInstanceArn(String idcInstanceArn)

        The ARN of the IAM Identity Center instance to create the Studio application.

        Parameters:
        idcInstanceArn - The ARN of the IAM Identity Center instance to create the Studio application.
      • getIdcInstanceArn

        public String getIdcInstanceArn()

        The ARN of the IAM Identity Center instance to create the Studio application.

        Returns:
        The ARN of the IAM Identity Center instance to create the Studio application.
      • withIdcInstanceArn

        public CreateStudioRequest withIdcInstanceArn(String idcInstanceArn)

        The ARN of the IAM Identity Center instance to create the Studio application.

        Parameters:
        idcInstanceArn - The ARN of the IAM Identity Center instance to create the Studio application.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setEncryptionKeyArn

        public void setEncryptionKeyArn(String encryptionKeyArn)

        The KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.

        Parameters:
        encryptionKeyArn - The KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
      • getEncryptionKeyArn

        public String getEncryptionKeyArn()

        The KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.

        Returns:
        The KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
      • withEncryptionKeyArn

        public CreateStudioRequest withEncryptionKeyArn(String encryptionKeyArn)

        The KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.

        Parameters:
        encryptionKeyArn - The KMS key identifier (ARN) used to encrypt Amazon EMR Studio workspace and notebook files when backed up to Amazon S3.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • toString

        public String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
Skip navigation links

AltStyle によって変換されたページ (->オリジナル) /