AWS SDK for C++  1.9.132
AWS SDK for C++
Public Member Functions | List of all members
Aws::EMR::Model::CreateStudioRequest Class Reference

#include <CreateStudioRequest.h>

+ Inheritance diagram for Aws::EMR::Model::CreateStudioRequest:

Public Member Functions

 CreateStudioRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
CreateStudioRequestWithName (const Aws::String &value)
 
CreateStudioRequestWithName (Aws::String &&value)
 
CreateStudioRequestWithName (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
CreateStudioRequestWithDescription (const Aws::String &value)
 
CreateStudioRequestWithDescription (Aws::String &&value)
 
CreateStudioRequestWithDescription (const char *value)
 
const AuthModeGetAuthMode () const
 
bool AuthModeHasBeenSet () const
 
void SetAuthMode (const AuthMode &value)
 
void SetAuthMode (AuthMode &&value)
 
CreateStudioRequestWithAuthMode (const AuthMode &value)
 
CreateStudioRequestWithAuthMode (AuthMode &&value)
 
const Aws::StringGetVpcId () const
 
bool VpcIdHasBeenSet () const
 
void SetVpcId (const Aws::String &value)
 
void SetVpcId (Aws::String &&value)
 
void SetVpcId (const char *value)
 
CreateStudioRequestWithVpcId (const Aws::String &value)
 
CreateStudioRequestWithVpcId (Aws::String &&value)
 
CreateStudioRequestWithVpcId (const char *value)
 
const Aws::Vector< Aws::String > & GetSubnetIds () const
 
bool SubnetIdsHasBeenSet () const
 
void SetSubnetIds (const Aws::Vector< Aws::String > &value)
 
void SetSubnetIds (Aws::Vector< Aws::String > &&value)
 
CreateStudioRequestWithSubnetIds (const Aws::Vector< Aws::String > &value)
 
CreateStudioRequestWithSubnetIds (Aws::Vector< Aws::String > &&value)
 
CreateStudioRequestAddSubnetIds (const Aws::String &value)
 
CreateStudioRequestAddSubnetIds (Aws::String &&value)
 
CreateStudioRequestAddSubnetIds (const char *value)
 
const Aws::StringGetServiceRole () const
 
bool ServiceRoleHasBeenSet () const
 
void SetServiceRole (const Aws::String &value)
 
void SetServiceRole (Aws::String &&value)
 
void SetServiceRole (const char *value)
 
CreateStudioRequestWithServiceRole (const Aws::String &value)
 
CreateStudioRequestWithServiceRole (Aws::String &&value)
 
CreateStudioRequestWithServiceRole (const char *value)
 
const Aws::StringGetUserRole () const
 
bool UserRoleHasBeenSet () const
 
void SetUserRole (const Aws::String &value)
 
void SetUserRole (Aws::String &&value)
 
void SetUserRole (const char *value)
 
CreateStudioRequestWithUserRole (const Aws::String &value)
 
CreateStudioRequestWithUserRole (Aws::String &&value)
 
CreateStudioRequestWithUserRole (const char *value)
 
const Aws::StringGetWorkspaceSecurityGroupId () const
 
bool WorkspaceSecurityGroupIdHasBeenSet () const
 
void SetWorkspaceSecurityGroupId (const Aws::String &value)
 
void SetWorkspaceSecurityGroupId (Aws::String &&value)
 
void SetWorkspaceSecurityGroupId (const char *value)
 
CreateStudioRequestWithWorkspaceSecurityGroupId (const Aws::String &value)
 
CreateStudioRequestWithWorkspaceSecurityGroupId (Aws::String &&value)
 
CreateStudioRequestWithWorkspaceSecurityGroupId (const char *value)
 
const Aws::StringGetEngineSecurityGroupId () const
 
bool EngineSecurityGroupIdHasBeenSet () const
 
void SetEngineSecurityGroupId (const Aws::String &value)
 
void SetEngineSecurityGroupId (Aws::String &&value)
 
void SetEngineSecurityGroupId (const char *value)
 
CreateStudioRequestWithEngineSecurityGroupId (const Aws::String &value)
 
CreateStudioRequestWithEngineSecurityGroupId (Aws::String &&value)
 
CreateStudioRequestWithEngineSecurityGroupId (const char *value)
 
const Aws::StringGetDefaultS3Location () const
 
bool DefaultS3LocationHasBeenSet () const
 
void SetDefaultS3Location (const Aws::String &value)
 
void SetDefaultS3Location (Aws::String &&value)
 
void SetDefaultS3Location (const char *value)
 
CreateStudioRequestWithDefaultS3Location (const Aws::String &value)
 
CreateStudioRequestWithDefaultS3Location (Aws::String &&value)
 
CreateStudioRequestWithDefaultS3Location (const char *value)
 
const Aws::StringGetIdpAuthUrl () const
 
bool IdpAuthUrlHasBeenSet () const
 
void SetIdpAuthUrl (const Aws::String &value)
 
void SetIdpAuthUrl (Aws::String &&value)
 
void SetIdpAuthUrl (const char *value)
 
CreateStudioRequestWithIdpAuthUrl (const Aws::String &value)
 
CreateStudioRequestWithIdpAuthUrl (Aws::String &&value)
 
CreateStudioRequestWithIdpAuthUrl (const char *value)
 
const Aws::StringGetIdpRelayStateParameterName () const
 
bool IdpRelayStateParameterNameHasBeenSet () const
 
void SetIdpRelayStateParameterName (const Aws::String &value)
 
void SetIdpRelayStateParameterName (Aws::String &&value)
 
void SetIdpRelayStateParameterName (const char *value)
 
CreateStudioRequestWithIdpRelayStateParameterName (const Aws::String &value)
 
CreateStudioRequestWithIdpRelayStateParameterName (Aws::String &&value)
 
CreateStudioRequestWithIdpRelayStateParameterName (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateStudioRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateStudioRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateStudioRequestAddTags (const Tag &value)
 
CreateStudioRequestAddTags (Tag &&value)
 
- Public Member Functions inherited from Aws::EMR::EMRRequest
virtual ~EMRRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 24 of file CreateStudioRequest.h.

Constructor & Destructor Documentation

◆ CreateStudioRequest()

Aws::EMR::Model::CreateStudioRequest::CreateStudioRequest ( )

Member Function Documentation

◆ AddSubnetIds() [1/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::AddSubnetIds ( Aws::String &&  value)
inline

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.

Definition at line 270 of file CreateStudioRequest.h.

◆ AddSubnetIds() [2/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::AddSubnetIds ( const Aws::String value)
inline

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.

Definition at line 262 of file CreateStudioRequest.h.

◆ AddSubnetIds() [3/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::AddSubnetIds ( const char *  value)
inline

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.

Definition at line 278 of file CreateStudioRequest.h.

◆ AddTags() [1/2]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::AddTags ( const Tag value)
inline

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.

Definition at line 767 of file CreateStudioRequest.h.

◆ AddTags() [2/2]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::AddTags ( Tag &&  value)
inline

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.

Definition at line 774 of file CreateStudioRequest.h.

◆ AuthModeHasBeenSet()

bool Aws::EMR::Model::CreateStudioRequest::AuthModeHasBeenSet ( ) const
inline

Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO.

Definition at line 132 of file CreateStudioRequest.h.

◆ DefaultS3LocationHasBeenSet()

bool Aws::EMR::Model::CreateStudioRequest::DefaultS3LocationHasBeenSet ( ) const
inline

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

Definition at line 543 of file CreateStudioRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::EMR::Model::CreateStudioRequest::DescriptionHasBeenSet ( ) const
inline

A detailed description of the Amazon EMR Studio.

Definition at line 89 of file CreateStudioRequest.h.

◆ EngineSecurityGroupIdHasBeenSet()

bool Aws::EMR::Model::CreateStudioRequest::EngineSecurityGroupIdHasBeenSet ( ) const
inline

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.

Definition at line 488 of file CreateStudioRequest.h.

◆ GetAuthMode()

const AuthMode& Aws::EMR::Model::CreateStudioRequest::GetAuthMode ( ) const
inline

Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO.

Definition at line 126 of file CreateStudioRequest.h.

◆ GetDefaultS3Location()

const Aws::String& Aws::EMR::Model::CreateStudioRequest::GetDefaultS3Location ( ) const
inline

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

Definition at line 537 of file CreateStudioRequest.h.

◆ GetDescription()

const Aws::String& Aws::EMR::Model::CreateStudioRequest::GetDescription ( ) const
inline

A detailed description of the Amazon EMR Studio.

Definition at line 84 of file CreateStudioRequest.h.

◆ GetEngineSecurityGroupId()

const Aws::String& Aws::EMR::Model::CreateStudioRequest::GetEngineSecurityGroupId ( ) const
inline

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.

Definition at line 481 of file CreateStudioRequest.h.

◆ GetIdpAuthUrl()

const Aws::String& Aws::EMR::Model::CreateStudioRequest::GetIdpAuthUrl ( ) const
inline

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.

Definition at line 588 of file CreateStudioRequest.h.

◆ GetIdpRelayStateParameterName()

const Aws::String& Aws::EMR::Model::CreateStudioRequest::GetIdpRelayStateParameterName ( ) const
inline

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.

Definition at line 654 of file CreateStudioRequest.h.

◆ GetName()

const Aws::String& Aws::EMR::Model::CreateStudioRequest::GetName ( ) const
inline

A descriptive name for the Amazon EMR Studio.

Definition at line 43 of file CreateStudioRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::EMR::Model::CreateStudioRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::EMR::EMRRequest.

◆ GetServiceRequestName()

virtual const char* Aws::EMR::Model::CreateStudioRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file CreateStudioRequest.h.

◆ GetServiceRole()

const Aws::String& Aws::EMR::Model::CreateStudioRequest::GetServiceRole ( ) const
inline

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.

Definition at line 286 of file CreateStudioRequest.h.

◆ GetSubnetIds()

const Aws::Vector<Aws::String>& Aws::EMR::Model::CreateStudioRequest::GetSubnetIds ( ) const
inline

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.

Definition at line 214 of file CreateStudioRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::EMR::Model::CreateStudioRequest::GetTags ( ) const
inline

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.

Definition at line 725 of file CreateStudioRequest.h.

◆ GetUserRole()

const Aws::String& Aws::EMR::Model::CreateStudioRequest::GetUserRole ( ) const
inline

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

Definition at line 345 of file CreateStudioRequest.h.

◆ GetVpcId()

const Aws::String& Aws::EMR::Model::CreateStudioRequest::GetVpcId ( ) const
inline

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

Definition at line 163 of file CreateStudioRequest.h.

◆ GetWorkspaceSecurityGroupId()

const Aws::String& Aws::EMR::Model::CreateStudioRequest::GetWorkspaceSecurityGroupId ( ) const
inline

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.

Definition at line 417 of file CreateStudioRequest.h.

◆ IdpAuthUrlHasBeenSet()

bool Aws::EMR::Model::CreateStudioRequest::IdpAuthUrlHasBeenSet ( ) const
inline

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.

Definition at line 596 of file CreateStudioRequest.h.

◆ IdpRelayStateParameterNameHasBeenSet()

bool Aws::EMR::Model::CreateStudioRequest::IdpRelayStateParameterNameHasBeenSet ( ) const
inline

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.

Definition at line 663 of file CreateStudioRequest.h.

◆ NameHasBeenSet()

bool Aws::EMR::Model::CreateStudioRequest::NameHasBeenSet ( ) const
inline

A descriptive name for the Amazon EMR Studio.

Definition at line 48 of file CreateStudioRequest.h.

◆ SerializePayload()

Aws::String Aws::EMR::Model::CreateStudioRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ ServiceRoleHasBeenSet()

bool Aws::EMR::Model::CreateStudioRequest::ServiceRoleHasBeenSet ( ) const
inline

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.

Definition at line 293 of file CreateStudioRequest.h.

◆ SetAuthMode() [1/2]

void Aws::EMR::Model::CreateStudioRequest::SetAuthMode ( AuthMode &&  value)
inline

Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO.

Definition at line 144 of file CreateStudioRequest.h.

◆ SetAuthMode() [2/2]

void Aws::EMR::Model::CreateStudioRequest::SetAuthMode ( const AuthMode value)
inline

Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO.

Definition at line 138 of file CreateStudioRequest.h.

◆ SetDefaultS3Location() [1/3]

void Aws::EMR::Model::CreateStudioRequest::SetDefaultS3Location ( Aws::String &&  value)
inline

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

Definition at line 555 of file CreateStudioRequest.h.

◆ SetDefaultS3Location() [2/3]

void Aws::EMR::Model::CreateStudioRequest::SetDefaultS3Location ( const Aws::String value)
inline

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

Definition at line 549 of file CreateStudioRequest.h.

◆ SetDefaultS3Location() [3/3]

void Aws::EMR::Model::CreateStudioRequest::SetDefaultS3Location ( const char *  value)
inline

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

Definition at line 561 of file CreateStudioRequest.h.

◆ SetDescription() [1/3]

void Aws::EMR::Model::CreateStudioRequest::SetDescription ( Aws::String &&  value)
inline

A detailed description of the Amazon EMR Studio.

Definition at line 99 of file CreateStudioRequest.h.

◆ SetDescription() [2/3]

void Aws::EMR::Model::CreateStudioRequest::SetDescription ( const Aws::String value)
inline

A detailed description of the Amazon EMR Studio.

Definition at line 94 of file CreateStudioRequest.h.

◆ SetDescription() [3/3]

void Aws::EMR::Model::CreateStudioRequest::SetDescription ( const char *  value)
inline

A detailed description of the Amazon EMR Studio.

Definition at line 104 of file CreateStudioRequest.h.

◆ SetEngineSecurityGroupId() [1/3]

void Aws::EMR::Model::CreateStudioRequest::SetEngineSecurityGroupId ( Aws::String &&  value)
inline

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.

Definition at line 502 of file CreateStudioRequest.h.

◆ SetEngineSecurityGroupId() [2/3]

void Aws::EMR::Model::CreateStudioRequest::SetEngineSecurityGroupId ( const Aws::String value)
inline

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.

Definition at line 495 of file CreateStudioRequest.h.

◆ SetEngineSecurityGroupId() [3/3]

void Aws::EMR::Model::CreateStudioRequest::SetEngineSecurityGroupId ( const char *  value)
inline

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.

Definition at line 509 of file CreateStudioRequest.h.

◆ SetIdpAuthUrl() [1/3]

void Aws::EMR::Model::CreateStudioRequest::SetIdpAuthUrl ( Aws::String &&  value)
inline

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.

Definition at line 612 of file CreateStudioRequest.h.

◆ SetIdpAuthUrl() [2/3]

void Aws::EMR::Model::CreateStudioRequest::SetIdpAuthUrl ( const Aws::String value)
inline

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.

Definition at line 604 of file CreateStudioRequest.h.

◆ SetIdpAuthUrl() [3/3]

void Aws::EMR::Model::CreateStudioRequest::SetIdpAuthUrl ( const char *  value)
inline

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.

Definition at line 620 of file CreateStudioRequest.h.

◆ SetIdpRelayStateParameterName() [1/3]

void Aws::EMR::Model::CreateStudioRequest::SetIdpRelayStateParameterName ( Aws::String &&  value)
inline

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.

Definition at line 681 of file CreateStudioRequest.h.

◆ SetIdpRelayStateParameterName() [2/3]

void Aws::EMR::Model::CreateStudioRequest::SetIdpRelayStateParameterName ( const Aws::String value)
inline

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.

Definition at line 672 of file CreateStudioRequest.h.

◆ SetIdpRelayStateParameterName() [3/3]

void Aws::EMR::Model::CreateStudioRequest::SetIdpRelayStateParameterName ( const char *  value)
inline

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.

Definition at line 690 of file CreateStudioRequest.h.

◆ SetName() [1/3]

void Aws::EMR::Model::CreateStudioRequest::SetName ( Aws::String &&  value)
inline

A descriptive name for the Amazon EMR Studio.

Definition at line 58 of file CreateStudioRequest.h.

◆ SetName() [2/3]

void Aws::EMR::Model::CreateStudioRequest::SetName ( const Aws::String value)
inline

A descriptive name for the Amazon EMR Studio.

Definition at line 53 of file CreateStudioRequest.h.

◆ SetName() [3/3]

void Aws::EMR::Model::CreateStudioRequest::SetName ( const char *  value)
inline

A descriptive name for the Amazon EMR Studio.

Definition at line 63 of file CreateStudioRequest.h.

◆ SetServiceRole() [1/3]

void Aws::EMR::Model::CreateStudioRequest::SetServiceRole ( Aws::String &&  value)
inline

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.

Definition at line 307 of file CreateStudioRequest.h.

◆ SetServiceRole() [2/3]

void Aws::EMR::Model::CreateStudioRequest::SetServiceRole ( const Aws::String value)
inline

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.

Definition at line 300 of file CreateStudioRequest.h.

◆ SetServiceRole() [3/3]

void Aws::EMR::Model::CreateStudioRequest::SetServiceRole ( const char *  value)
inline

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.

Definition at line 314 of file CreateStudioRequest.h.

◆ SetSubnetIds() [1/2]

void Aws::EMR::Model::CreateStudioRequest::SetSubnetIds ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 238 of file CreateStudioRequest.h.

◆ SetSubnetIds() [2/2]

void Aws::EMR::Model::CreateStudioRequest::SetSubnetIds ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 230 of file CreateStudioRequest.h.

◆ SetTags() [1/2]

void Aws::EMR::Model::CreateStudioRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

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.

Definition at line 746 of file CreateStudioRequest.h.

◆ SetTags() [2/2]

void Aws::EMR::Model::CreateStudioRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

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.

Definition at line 739 of file CreateStudioRequest.h.

◆ SetUserRole() [1/3]

void Aws::EMR::Model::CreateStudioRequest::SetUserRole ( Aws::String &&  value)
inline

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

Definition at line 372 of file CreateStudioRequest.h.

◆ SetUserRole() [2/3]

void Aws::EMR::Model::CreateStudioRequest::SetUserRole ( const Aws::String value)
inline

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

Definition at line 363 of file CreateStudioRequest.h.

◆ SetUserRole() [3/3]

void Aws::EMR::Model::CreateStudioRequest::SetUserRole ( const char *  value)
inline

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

Definition at line 381 of file CreateStudioRequest.h.

◆ SetVpcId() [1/3]

void Aws::EMR::Model::CreateStudioRequest::SetVpcId ( Aws::String &&  value)
inline

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

Definition at line 181 of file CreateStudioRequest.h.

◆ SetVpcId() [2/3]

void Aws::EMR::Model::CreateStudioRequest::SetVpcId ( const Aws::String value)
inline

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

Definition at line 175 of file CreateStudioRequest.h.

◆ SetVpcId() [3/3]

void Aws::EMR::Model::CreateStudioRequest::SetVpcId ( const char *  value)
inline

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

Definition at line 187 of file CreateStudioRequest.h.

◆ SetWorkspaceSecurityGroupId() [1/3]

void Aws::EMR::Model::CreateStudioRequest::SetWorkspaceSecurityGroupId ( Aws::String &&  value)
inline

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.

Definition at line 441 of file CreateStudioRequest.h.

◆ SetWorkspaceSecurityGroupId() [2/3]

void Aws::EMR::Model::CreateStudioRequest::SetWorkspaceSecurityGroupId ( const Aws::String value)
inline

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.

Definition at line 433 of file CreateStudioRequest.h.

◆ SetWorkspaceSecurityGroupId() [3/3]

void Aws::EMR::Model::CreateStudioRequest::SetWorkspaceSecurityGroupId ( const char *  value)
inline

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.

Definition at line 449 of file CreateStudioRequest.h.

◆ SubnetIdsHasBeenSet()

bool Aws::EMR::Model::CreateStudioRequest::SubnetIdsHasBeenSet ( ) const
inline

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.

Definition at line 222 of file CreateStudioRequest.h.

◆ TagsHasBeenSet()

bool Aws::EMR::Model::CreateStudioRequest::TagsHasBeenSet ( ) const
inline

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.

Definition at line 732 of file CreateStudioRequest.h.

◆ UserRoleHasBeenSet()

bool Aws::EMR::Model::CreateStudioRequest::UserRoleHasBeenSet ( ) const
inline

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

Definition at line 354 of file CreateStudioRequest.h.

◆ VpcIdHasBeenSet()

bool Aws::EMR::Model::CreateStudioRequest::VpcIdHasBeenSet ( ) const
inline

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

Definition at line 169 of file CreateStudioRequest.h.

◆ WithAuthMode() [1/2]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithAuthMode ( AuthMode &&  value)
inline

Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO.

Definition at line 156 of file CreateStudioRequest.h.

◆ WithAuthMode() [2/2]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithAuthMode ( const AuthMode value)
inline

Specifies whether the Studio authenticates users using IAM or Amazon Web Services SSO.

Definition at line 150 of file CreateStudioRequest.h.

◆ WithDefaultS3Location() [1/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithDefaultS3Location ( Aws::String &&  value)
inline

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

Definition at line 573 of file CreateStudioRequest.h.

◆ WithDefaultS3Location() [2/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithDefaultS3Location ( const Aws::String value)
inline

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

Definition at line 567 of file CreateStudioRequest.h.

◆ WithDefaultS3Location() [3/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithDefaultS3Location ( const char *  value)
inline

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

Definition at line 579 of file CreateStudioRequest.h.

◆ WithDescription() [1/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithDescription ( Aws::String &&  value)
inline

A detailed description of the Amazon EMR Studio.

Definition at line 114 of file CreateStudioRequest.h.

◆ WithDescription() [2/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithDescription ( const Aws::String value)
inline

A detailed description of the Amazon EMR Studio.

Definition at line 109 of file CreateStudioRequest.h.

◆ WithDescription() [3/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithDescription ( const char *  value)
inline

A detailed description of the Amazon EMR Studio.

Definition at line 119 of file CreateStudioRequest.h.

◆ WithEngineSecurityGroupId() [1/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithEngineSecurityGroupId ( Aws::String &&  value)
inline

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.

Definition at line 523 of file CreateStudioRequest.h.

◆ WithEngineSecurityGroupId() [2/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithEngineSecurityGroupId ( const Aws::String value)
inline

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.

Definition at line 516 of file CreateStudioRequest.h.

◆ WithEngineSecurityGroupId() [3/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithEngineSecurityGroupId ( const char *  value)
inline

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.

Definition at line 530 of file CreateStudioRequest.h.

◆ WithIdpAuthUrl() [1/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithIdpAuthUrl ( Aws::String &&  value)
inline

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.

Definition at line 636 of file CreateStudioRequest.h.

◆ WithIdpAuthUrl() [2/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithIdpAuthUrl ( const Aws::String value)
inline

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.

Definition at line 628 of file CreateStudioRequest.h.

◆ WithIdpAuthUrl() [3/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithIdpAuthUrl ( const char *  value)
inline

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.

Definition at line 644 of file CreateStudioRequest.h.

◆ WithIdpRelayStateParameterName() [1/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithIdpRelayStateParameterName ( Aws::String &&  value)
inline

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.

Definition at line 708 of file CreateStudioRequest.h.

◆ WithIdpRelayStateParameterName() [2/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithIdpRelayStateParameterName ( const Aws::String value)
inline

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.

Definition at line 699 of file CreateStudioRequest.h.

◆ WithIdpRelayStateParameterName() [3/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithIdpRelayStateParameterName ( const char *  value)
inline

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.

Definition at line 717 of file CreateStudioRequest.h.

◆ WithName() [1/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithName ( Aws::String &&  value)
inline

A descriptive name for the Amazon EMR Studio.

Definition at line 73 of file CreateStudioRequest.h.

◆ WithName() [2/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithName ( const Aws::String value)
inline

A descriptive name for the Amazon EMR Studio.

Definition at line 68 of file CreateStudioRequest.h.

◆ WithName() [3/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithName ( const char *  value)
inline

A descriptive name for the Amazon EMR Studio.

Definition at line 78 of file CreateStudioRequest.h.

◆ WithServiceRole() [1/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithServiceRole ( Aws::String &&  value)
inline

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.

Definition at line 328 of file CreateStudioRequest.h.

◆ WithServiceRole() [2/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithServiceRole ( const Aws::String value)
inline

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.

Definition at line 321 of file CreateStudioRequest.h.

◆ WithServiceRole() [3/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithServiceRole ( const char *  value)
inline

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.

Definition at line 335 of file CreateStudioRequest.h.

◆ WithSubnetIds() [1/2]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithSubnetIds ( Aws::Vector< Aws::String > &&  value)
inline

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.

Definition at line 254 of file CreateStudioRequest.h.

◆ WithSubnetIds() [2/2]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithSubnetIds ( const Aws::Vector< Aws::String > &  value)
inline

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.

Definition at line 246 of file CreateStudioRequest.h.

◆ WithTags() [1/2]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

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.

Definition at line 760 of file CreateStudioRequest.h.

◆ WithTags() [2/2]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

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.

Definition at line 753 of file CreateStudioRequest.h.

◆ WithUserRole() [1/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithUserRole ( Aws::String &&  value)
inline

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

Definition at line 399 of file CreateStudioRequest.h.

◆ WithUserRole() [2/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithUserRole ( const Aws::String value)
inline

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

Definition at line 390 of file CreateStudioRequest.h.

◆ WithUserRole() [3/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithUserRole ( const char *  value)
inline

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

Definition at line 408 of file CreateStudioRequest.h.

◆ WithVpcId() [1/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithVpcId ( Aws::String &&  value)
inline

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

Definition at line 199 of file CreateStudioRequest.h.

◆ WithVpcId() [2/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithVpcId ( const Aws::String value)
inline

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

Definition at line 193 of file CreateStudioRequest.h.

◆ WithVpcId() [3/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithVpcId ( const char *  value)
inline

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

Definition at line 205 of file CreateStudioRequest.h.

◆ WithWorkspaceSecurityGroupId() [1/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithWorkspaceSecurityGroupId ( Aws::String &&  value)
inline

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.

Definition at line 465 of file CreateStudioRequest.h.

◆ WithWorkspaceSecurityGroupId() [2/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithWorkspaceSecurityGroupId ( const Aws::String value)
inline

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.

Definition at line 457 of file CreateStudioRequest.h.

◆ WithWorkspaceSecurityGroupId() [3/3]

CreateStudioRequest& Aws::EMR::Model::CreateStudioRequest::WithWorkspaceSecurityGroupId ( const char *  value)
inline

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.

Definition at line 473 of file CreateStudioRequest.h.

◆ WorkspaceSecurityGroupIdHasBeenSet()

bool Aws::EMR::Model::CreateStudioRequest::WorkspaceSecurityGroupIdHasBeenSet ( ) const
inline

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.

Definition at line 425 of file CreateStudioRequest.h.


The documentation for this class was generated from the following file: