AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::GameLift::Model::CreateScriptRequest Class Reference

#include <CreateScriptRequest.h>

+ Inheritance diagram for Aws::GameLift::Model::CreateScriptRequest:

Public Member Functions

 CreateScriptRequest ()
 
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)
 
CreateScriptRequestWithName (const Aws::String &value)
 
CreateScriptRequestWithName (Aws::String &&value)
 
CreateScriptRequestWithName (const char *value)
 
const Aws::StringGetVersion () const
 
bool VersionHasBeenSet () const
 
void SetVersion (const Aws::String &value)
 
void SetVersion (Aws::String &&value)
 
void SetVersion (const char *value)
 
CreateScriptRequestWithVersion (const Aws::String &value)
 
CreateScriptRequestWithVersion (Aws::String &&value)
 
CreateScriptRequestWithVersion (const char *value)
 
const S3LocationGetStorageLocation () const
 
bool StorageLocationHasBeenSet () const
 
void SetStorageLocation (const S3Location &value)
 
void SetStorageLocation (S3Location &&value)
 
CreateScriptRequestWithStorageLocation (const S3Location &value)
 
CreateScriptRequestWithStorageLocation (S3Location &&value)
 
const Aws::Utils::ByteBufferGetZipFile () const
 
bool ZipFileHasBeenSet () const
 
void SetZipFile (const Aws::Utils::ByteBuffer &value)
 
void SetZipFile (Aws::Utils::ByteBuffer &&value)
 
CreateScriptRequestWithZipFile (const Aws::Utils::ByteBuffer &value)
 
CreateScriptRequestWithZipFile (Aws::Utils::ByteBuffer &&value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateScriptRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateScriptRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateScriptRequestAddTags (const Tag &value)
 
CreateScriptRequestAddTags (Tag &&value)
 
- Public Member Functions inherited from Aws::GameLift::GameLiftRequest
virtual ~GameLiftRequest ()
 
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 25 of file CreateScriptRequest.h.

Constructor & Destructor Documentation

◆ CreateScriptRequest()

Aws::GameLift::Model::CreateScriptRequest::CreateScriptRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

CreateScriptRequest& Aws::GameLift::Model::CreateScriptRequest::AddTags ( const Tag value)
inline

A list of labels to assign to the new script resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Definition at line 396 of file CreateScriptRequest.h.

◆ AddTags() [2/2]

CreateScriptRequest& Aws::GameLift::Model::CreateScriptRequest::AddTags ( Tag &&  value)
inline

A list of labels to assign to the new script resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Definition at line 409 of file CreateScriptRequest.h.

◆ GetName()

const Aws::String& Aws::GameLift::Model::CreateScriptRequest::GetName ( ) const
inline

A descriptive label that is associated with a script. Script names do not need to be unique. You can use UpdateScript to change this value later.

Definition at line 46 of file CreateScriptRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::GameLift::Model::CreateScriptRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::GameLift::GameLiftRequest.

◆ GetServiceRequestName()

virtual const char* Aws::GameLift::Model::CreateScriptRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file CreateScriptRequest.h.

◆ GetStorageLocation()

const S3Location& Aws::GameLift::Model::CreateScriptRequest::GetStorageLocation ( ) const
inline

The Amazon S3 location of your Realtime scripts. The storage location must specify the S3 bucket name, the zip file name (the "key"), and an IAM role ARN that allows Amazon GameLift to access the S3 storage location. The S3 bucket must be in the same Region where you are creating a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version. To call this operation with a storage location, you must have IAM PassRole permission. For more details on IAM roles and PassRole permissions, see Set up a role for GameLift access.

Definition at line 168 of file CreateScriptRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::GameLift::Model::CreateScriptRequest::GetTags ( ) const
inline

A list of labels to assign to the new script resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Definition at line 318 of file CreateScriptRequest.h.

◆ GetVersion()

const Aws::String& Aws::GameLift::Model::CreateScriptRequest::GetVersion ( ) const
inline

The version that is associated with a build or script. Version strings do not need to be unique. You can use UpdateScript to change this value later.

Definition at line 103 of file CreateScriptRequest.h.

◆ GetZipFile()

const Aws::Utils::ByteBuffer& Aws::GameLift::Model::CreateScriptRequest::GetZipFile ( ) const
inline

A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.

When using the AWS CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. For example: –zip-file fileb://myRealtimeScript.zip.

Definition at line 254 of file CreateScriptRequest.h.

◆ NameHasBeenSet()

bool Aws::GameLift::Model::CreateScriptRequest::NameHasBeenSet ( ) const
inline

A descriptive label that is associated with a script. Script names do not need to be unique. You can use UpdateScript to change this value later.

Definition at line 53 of file CreateScriptRequest.h.

◆ SerializePayload()

Aws::String Aws::GameLift::Model::CreateScriptRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetName() [1/3]

void Aws::GameLift::Model::CreateScriptRequest::SetName ( const Aws::String value)
inline

A descriptive label that is associated with a script. Script names do not need to be unique. You can use UpdateScript to change this value later.

Definition at line 60 of file CreateScriptRequest.h.

◆ SetName() [2/3]

void Aws::GameLift::Model::CreateScriptRequest::SetName ( Aws::String &&  value)
inline

A descriptive label that is associated with a script. Script names do not need to be unique. You can use UpdateScript to change this value later.

Definition at line 67 of file CreateScriptRequest.h.

◆ SetName() [3/3]

void Aws::GameLift::Model::CreateScriptRequest::SetName ( const char *  value)
inline

A descriptive label that is associated with a script. Script names do not need to be unique. You can use UpdateScript to change this value later.

Definition at line 74 of file CreateScriptRequest.h.

◆ SetStorageLocation() [1/2]

void Aws::GameLift::Model::CreateScriptRequest::SetStorageLocation ( const S3Location value)
inline

The Amazon S3 location of your Realtime scripts. The storage location must specify the S3 bucket name, the zip file name (the "key"), and an IAM role ARN that allows Amazon GameLift to access the S3 storage location. The S3 bucket must be in the same Region where you are creating a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version. To call this operation with a storage location, you must have IAM PassRole permission. For more details on IAM roles and PassRole permissions, see Set up a role for GameLift access.

Definition at line 198 of file CreateScriptRequest.h.

◆ SetStorageLocation() [2/2]

void Aws::GameLift::Model::CreateScriptRequest::SetStorageLocation ( S3Location &&  value)
inline

The Amazon S3 location of your Realtime scripts. The storage location must specify the S3 bucket name, the zip file name (the "key"), and an IAM role ARN that allows Amazon GameLift to access the S3 storage location. The S3 bucket must be in the same Region where you are creating a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version. To call this operation with a storage location, you must have IAM PassRole permission. For more details on IAM roles and PassRole permissions, see Set up a role for GameLift access.

Definition at line 213 of file CreateScriptRequest.h.

◆ SetTags() [1/2]

void Aws::GameLift::Model::CreateScriptRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

A list of labels to assign to the new script resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Definition at line 344 of file CreateScriptRequest.h.

◆ SetTags() [2/2]

void Aws::GameLift::Model::CreateScriptRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

A list of labels to assign to the new script resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Definition at line 357 of file CreateScriptRequest.h.

◆ SetVersion() [1/3]

void Aws::GameLift::Model::CreateScriptRequest::SetVersion ( const Aws::String value)
inline

The version that is associated with a build or script. Version strings do not need to be unique. You can use UpdateScript to change this value later.

Definition at line 117 of file CreateScriptRequest.h.

◆ SetVersion() [2/3]

void Aws::GameLift::Model::CreateScriptRequest::SetVersion ( Aws::String &&  value)
inline

The version that is associated with a build or script. Version strings do not need to be unique. You can use UpdateScript to change this value later.

Definition at line 124 of file CreateScriptRequest.h.

◆ SetVersion() [3/3]

void Aws::GameLift::Model::CreateScriptRequest::SetVersion ( const char *  value)
inline

The version that is associated with a build or script. Version strings do not need to be unique. You can use UpdateScript to change this value later.

Definition at line 131 of file CreateScriptRequest.h.

◆ SetZipFile() [1/2]

void Aws::GameLift::Model::CreateScriptRequest::SetZipFile ( const Aws::Utils::ByteBuffer value)
inline

A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.

When using the AWS CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. For example: –zip-file fileb://myRealtimeScript.zip.

Definition at line 274 of file CreateScriptRequest.h.

◆ SetZipFile() [2/2]

void Aws::GameLift::Model::CreateScriptRequest::SetZipFile ( Aws::Utils::ByteBuffer &&  value)
inline

A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.

When using the AWS CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. For example: –zip-file fileb://myRealtimeScript.zip.

Definition at line 284 of file CreateScriptRequest.h.

◆ StorageLocationHasBeenSet()

bool Aws::GameLift::Model::CreateScriptRequest::StorageLocationHasBeenSet ( ) const
inline

The Amazon S3 location of your Realtime scripts. The storage location must specify the S3 bucket name, the zip file name (the "key"), and an IAM role ARN that allows Amazon GameLift to access the S3 storage location. The S3 bucket must be in the same Region where you are creating a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version. To call this operation with a storage location, you must have IAM PassRole permission. For more details on IAM roles and PassRole permissions, see Set up a role for GameLift access.

Definition at line 183 of file CreateScriptRequest.h.

◆ TagsHasBeenSet()

bool Aws::GameLift::Model::CreateScriptRequest::TagsHasBeenSet ( ) const
inline

A list of labels to assign to the new script resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Definition at line 331 of file CreateScriptRequest.h.

◆ VersionHasBeenSet()

bool Aws::GameLift::Model::CreateScriptRequest::VersionHasBeenSet ( ) const
inline

The version that is associated with a build or script. Version strings do not need to be unique. You can use UpdateScript to change this value later.

Definition at line 110 of file CreateScriptRequest.h.

◆ WithName() [1/3]

CreateScriptRequest& Aws::GameLift::Model::CreateScriptRequest::WithName ( const Aws::String value)
inline

A descriptive label that is associated with a script. Script names do not need to be unique. You can use UpdateScript to change this value later.

Definition at line 81 of file CreateScriptRequest.h.

◆ WithName() [2/3]

CreateScriptRequest& Aws::GameLift::Model::CreateScriptRequest::WithName ( Aws::String &&  value)
inline

A descriptive label that is associated with a script. Script names do not need to be unique. You can use UpdateScript to change this value later.

Definition at line 88 of file CreateScriptRequest.h.

◆ WithName() [3/3]

CreateScriptRequest& Aws::GameLift::Model::CreateScriptRequest::WithName ( const char *  value)
inline

A descriptive label that is associated with a script. Script names do not need to be unique. You can use UpdateScript to change this value later.

Definition at line 95 of file CreateScriptRequest.h.

◆ WithStorageLocation() [1/2]

CreateScriptRequest& Aws::GameLift::Model::CreateScriptRequest::WithStorageLocation ( const S3Location value)
inline

The Amazon S3 location of your Realtime scripts. The storage location must specify the S3 bucket name, the zip file name (the "key"), and an IAM role ARN that allows Amazon GameLift to access the S3 storage location. The S3 bucket must be in the same Region where you are creating a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version. To call this operation with a storage location, you must have IAM PassRole permission. For more details on IAM roles and PassRole permissions, see Set up a role for GameLift access.

Definition at line 228 of file CreateScriptRequest.h.

◆ WithStorageLocation() [2/2]

CreateScriptRequest& Aws::GameLift::Model::CreateScriptRequest::WithStorageLocation ( S3Location &&  value)
inline

The Amazon S3 location of your Realtime scripts. The storage location must specify the S3 bucket name, the zip file name (the "key"), and an IAM role ARN that allows Amazon GameLift to access the S3 storage location. The S3 bucket must be in the same Region where you are creating a new script. By default, Amazon GameLift uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the ObjectVersion parameter to specify an earlier version. To call this operation with a storage location, you must have IAM PassRole permission. For more details on IAM roles and PassRole permissions, see Set up a role for GameLift access.

Definition at line 243 of file CreateScriptRequest.h.

◆ WithTags() [1/2]

CreateScriptRequest& Aws::GameLift::Model::CreateScriptRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

A list of labels to assign to the new script resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Definition at line 370 of file CreateScriptRequest.h.

◆ WithTags() [2/2]

CreateScriptRequest& Aws::GameLift::Model::CreateScriptRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

A list of labels to assign to the new script resource. Tags are developer-defined key-value pairs. Tagging AWS resources are useful for resource management, access management and cost allocation. For more information, see Tagging AWS Resources in the AWS General Reference. Once the resource is created, you can use TagResource, UntagResource, and ListTagsForResource to add, remove, and view tags. The maximum tag limit may be lower than stated. See the AWS General Reference for actual tagging limits.

Definition at line 383 of file CreateScriptRequest.h.

◆ WithVersion() [1/3]

CreateScriptRequest& Aws::GameLift::Model::CreateScriptRequest::WithVersion ( const Aws::String value)
inline

The version that is associated with a build or script. Version strings do not need to be unique. You can use UpdateScript to change this value later.

Definition at line 138 of file CreateScriptRequest.h.

◆ WithVersion() [2/3]

CreateScriptRequest& Aws::GameLift::Model::CreateScriptRequest::WithVersion ( Aws::String &&  value)
inline

The version that is associated with a build or script. Version strings do not need to be unique. You can use UpdateScript to change this value later.

Definition at line 145 of file CreateScriptRequest.h.

◆ WithVersion() [3/3]

CreateScriptRequest& Aws::GameLift::Model::CreateScriptRequest::WithVersion ( const char *  value)
inline

The version that is associated with a build or script. Version strings do not need to be unique. You can use UpdateScript to change this value later.

Definition at line 152 of file CreateScriptRequest.h.

◆ WithZipFile() [1/2]

CreateScriptRequest& Aws::GameLift::Model::CreateScriptRequest::WithZipFile ( const Aws::Utils::ByteBuffer value)
inline

A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.

When using the AWS CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. For example: –zip-file fileb://myRealtimeScript.zip.

Definition at line 294 of file CreateScriptRequest.h.

◆ WithZipFile() [2/2]

CreateScriptRequest& Aws::GameLift::Model::CreateScriptRequest::WithZipFile ( Aws::Utils::ByteBuffer &&  value)
inline

A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.

When using the AWS CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. For example: –zip-file fileb://myRealtimeScript.zip.

Definition at line 304 of file CreateScriptRequest.h.

◆ ZipFileHasBeenSet()

bool Aws::GameLift::Model::CreateScriptRequest::ZipFileHasBeenSet ( ) const
inline

A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.

When using the AWS CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. For example: –zip-file fileb://myRealtimeScript.zip.

Definition at line 264 of file CreateScriptRequest.h.


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