AWS SDK for C++  1.8.79
AWS SDK for C++
Public Member Functions | List of all members
Aws::APIGateway::Model::Deployment Class Reference

#include <Deployment.h>

Public Member Functions

 Deployment ()
 
 Deployment (Aws::Utils::Json::JsonView jsonValue)
 
Deploymentoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetId () const
 
bool IdHasBeenSet () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
DeploymentWithId (const Aws::String &value)
 
DeploymentWithId (Aws::String &&value)
 
DeploymentWithId (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)
 
DeploymentWithDescription (const Aws::String &value)
 
DeploymentWithDescription (Aws::String &&value)
 
DeploymentWithDescription (const char *value)
 
const Aws::Utils::DateTimeGetCreatedDate () const
 
bool CreatedDateHasBeenSet () const
 
void SetCreatedDate (const Aws::Utils::DateTime &value)
 
void SetCreatedDate (Aws::Utils::DateTime &&value)
 
DeploymentWithCreatedDate (const Aws::Utils::DateTime &value)
 
DeploymentWithCreatedDate (Aws::Utils::DateTime &&value)
 
const Aws::Map< Aws::String, Aws::Map< Aws::String, MethodSnapshot > > & GetApiSummary () const
 
bool ApiSummaryHasBeenSet () const
 
void SetApiSummary (const Aws::Map< Aws::String, Aws::Map< Aws::String, MethodSnapshot >> &value)
 
void SetApiSummary (Aws::Map< Aws::String, Aws::Map< Aws::String, MethodSnapshot >> &&value)
 
DeploymentWithApiSummary (const Aws::Map< Aws::String, Aws::Map< Aws::String, MethodSnapshot >> &value)
 
DeploymentWithApiSummary (Aws::Map< Aws::String, Aws::Map< Aws::String, MethodSnapshot >> &&value)
 
DeploymentAddApiSummary (const Aws::String &key, const Aws::Map< Aws::String, MethodSnapshot > &value)
 
DeploymentAddApiSummary (Aws::String &&key, const Aws::Map< Aws::String, MethodSnapshot > &value)
 
DeploymentAddApiSummary (const Aws::String &key, Aws::Map< Aws::String, MethodSnapshot > &&value)
 
DeploymentAddApiSummary (Aws::String &&key, Aws::Map< Aws::String, MethodSnapshot > &&value)
 
DeploymentAddApiSummary (const char *key, Aws::Map< Aws::String, MethodSnapshot > &&value)
 
DeploymentAddApiSummary (const char *key, const Aws::Map< Aws::String, MethodSnapshot > &value)
 

Detailed Description

An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.

To create a deployment, call POST on the Deployments resource of a RestApi. To view, update, or delete a deployment, call GET, PATCH, or DELETE on the specified deployment resource (/restapis/{restapi_id}/deployments/{deployment_id}).
RestApi, Deployments, Stage, AWS CLI, AWS SDKs

See Also:

AWS API Reference

Definition at line 45 of file Deployment.h.

Constructor & Destructor Documentation

◆ Deployment() [1/2]

Aws::APIGateway::Model::Deployment::Deployment ( )

◆ Deployment() [2/2]

Aws::APIGateway::Model::Deployment::Deployment ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddApiSummary() [1/6]

Deployment& Aws::APIGateway::Model::Deployment::AddApiSummary ( const Aws::String key,
const Aws::Map< Aws::String, MethodSnapshot > &  value 
)
inline

A summary of the RestApi at the date and time that the deployment resource was created.

Definition at line 207 of file Deployment.h.

◆ AddApiSummary() [2/6]

Deployment& Aws::APIGateway::Model::Deployment::AddApiSummary ( Aws::String &&  key,
const Aws::Map< Aws::String, MethodSnapshot > &  value 
)
inline

A summary of the RestApi at the date and time that the deployment resource was created.

Definition at line 213 of file Deployment.h.

◆ AddApiSummary() [3/6]

Deployment& Aws::APIGateway::Model::Deployment::AddApiSummary ( const Aws::String key,
Aws::Map< Aws::String, MethodSnapshot > &&  value 
)
inline

A summary of the RestApi at the date and time that the deployment resource was created.

Definition at line 219 of file Deployment.h.

◆ AddApiSummary() [4/6]

Deployment& Aws::APIGateway::Model::Deployment::AddApiSummary ( Aws::String &&  key,
Aws::Map< Aws::String, MethodSnapshot > &&  value 
)
inline

A summary of the RestApi at the date and time that the deployment resource was created.

Definition at line 225 of file Deployment.h.

◆ AddApiSummary() [5/6]

Deployment& Aws::APIGateway::Model::Deployment::AddApiSummary ( const char *  key,
Aws::Map< Aws::String, MethodSnapshot > &&  value 
)
inline

A summary of the RestApi at the date and time that the deployment resource was created.

Definition at line 231 of file Deployment.h.

◆ AddApiSummary() [6/6]

Deployment& Aws::APIGateway::Model::Deployment::AddApiSummary ( const char *  key,
const Aws::Map< Aws::String, MethodSnapshot > &  value 
)
inline

A summary of the RestApi at the date and time that the deployment resource was created.

Definition at line 237 of file Deployment.h.

◆ ApiSummaryHasBeenSet()

bool Aws::APIGateway::Model::Deployment::ApiSummaryHasBeenSet ( ) const
inline

A summary of the RestApi at the date and time that the deployment resource was created.

Definition at line 177 of file Deployment.h.

◆ CreatedDateHasBeenSet()

bool Aws::APIGateway::Model::Deployment::CreatedDateHasBeenSet ( ) const
inline

The date and time that the deployment resource was created.

Definition at line 144 of file Deployment.h.

◆ DescriptionHasBeenSet()

bool Aws::APIGateway::Model::Deployment::DescriptionHasBeenSet ( ) const
inline

The description for the deployment resource.

Definition at line 103 of file Deployment.h.

◆ GetApiSummary()

const Aws::Map<Aws::String, Aws::Map<Aws::String, MethodSnapshot> >& Aws::APIGateway::Model::Deployment::GetApiSummary ( ) const
inline

A summary of the RestApi at the date and time that the deployment resource was created.

Definition at line 171 of file Deployment.h.

◆ GetCreatedDate()

const Aws::Utils::DateTime& Aws::APIGateway::Model::Deployment::GetCreatedDate ( ) const
inline

The date and time that the deployment resource was created.

Definition at line 139 of file Deployment.h.

◆ GetDescription()

const Aws::String& Aws::APIGateway::Model::Deployment::GetDescription ( ) const
inline

The description for the deployment resource.

Definition at line 98 of file Deployment.h.

◆ GetId()

const Aws::String& Aws::APIGateway::Model::Deployment::GetId ( ) const
inline

The identifier for the deployment resource.

Definition at line 57 of file Deployment.h.

◆ IdHasBeenSet()

bool Aws::APIGateway::Model::Deployment::IdHasBeenSet ( ) const
inline

The identifier for the deployment resource.

Definition at line 62 of file Deployment.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::APIGateway::Model::Deployment::Jsonize ( ) const

◆ operator=()

Deployment& Aws::APIGateway::Model::Deployment::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetApiSummary() [1/2]

void Aws::APIGateway::Model::Deployment::SetApiSummary ( const Aws::Map< Aws::String, Aws::Map< Aws::String, MethodSnapshot >> &  value)
inline

A summary of the RestApi at the date and time that the deployment resource was created.

Definition at line 183 of file Deployment.h.

◆ SetApiSummary() [2/2]

void Aws::APIGateway::Model::Deployment::SetApiSummary ( Aws::Map< Aws::String, Aws::Map< Aws::String, MethodSnapshot >> &&  value)
inline

A summary of the RestApi at the date and time that the deployment resource was created.

Definition at line 189 of file Deployment.h.

◆ SetCreatedDate() [1/2]

void Aws::APIGateway::Model::Deployment::SetCreatedDate ( const Aws::Utils::DateTime value)
inline

The date and time that the deployment resource was created.

Definition at line 149 of file Deployment.h.

◆ SetCreatedDate() [2/2]

void Aws::APIGateway::Model::Deployment::SetCreatedDate ( Aws::Utils::DateTime &&  value)
inline

The date and time that the deployment resource was created.

Definition at line 154 of file Deployment.h.

◆ SetDescription() [1/3]

void Aws::APIGateway::Model::Deployment::SetDescription ( const Aws::String value)
inline

The description for the deployment resource.

Definition at line 108 of file Deployment.h.

◆ SetDescription() [2/3]

void Aws::APIGateway::Model::Deployment::SetDescription ( Aws::String &&  value)
inline

The description for the deployment resource.

Definition at line 113 of file Deployment.h.

◆ SetDescription() [3/3]

void Aws::APIGateway::Model::Deployment::SetDescription ( const char *  value)
inline

The description for the deployment resource.

Definition at line 118 of file Deployment.h.

◆ SetId() [1/3]

void Aws::APIGateway::Model::Deployment::SetId ( const Aws::String value)
inline

The identifier for the deployment resource.

Definition at line 67 of file Deployment.h.

◆ SetId() [2/3]

void Aws::APIGateway::Model::Deployment::SetId ( Aws::String &&  value)
inline

The identifier for the deployment resource.

Definition at line 72 of file Deployment.h.

◆ SetId() [3/3]

void Aws::APIGateway::Model::Deployment::SetId ( const char *  value)
inline

The identifier for the deployment resource.

Definition at line 77 of file Deployment.h.

◆ WithApiSummary() [1/2]

Deployment& Aws::APIGateway::Model::Deployment::WithApiSummary ( const Aws::Map< Aws::String, Aws::Map< Aws::String, MethodSnapshot >> &  value)
inline

A summary of the RestApi at the date and time that the deployment resource was created.

Definition at line 195 of file Deployment.h.

◆ WithApiSummary() [2/2]

Deployment& Aws::APIGateway::Model::Deployment::WithApiSummary ( Aws::Map< Aws::String, Aws::Map< Aws::String, MethodSnapshot >> &&  value)
inline

A summary of the RestApi at the date and time that the deployment resource was created.

Definition at line 201 of file Deployment.h.

◆ WithCreatedDate() [1/2]

Deployment& Aws::APIGateway::Model::Deployment::WithCreatedDate ( const Aws::Utils::DateTime value)
inline

The date and time that the deployment resource was created.

Definition at line 159 of file Deployment.h.

◆ WithCreatedDate() [2/2]

Deployment& Aws::APIGateway::Model::Deployment::WithCreatedDate ( Aws::Utils::DateTime &&  value)
inline

The date and time that the deployment resource was created.

Definition at line 164 of file Deployment.h.

◆ WithDescription() [1/3]

Deployment& Aws::APIGateway::Model::Deployment::WithDescription ( const Aws::String value)
inline

The description for the deployment resource.

Definition at line 123 of file Deployment.h.

◆ WithDescription() [2/3]

Deployment& Aws::APIGateway::Model::Deployment::WithDescription ( Aws::String &&  value)
inline

The description for the deployment resource.

Definition at line 128 of file Deployment.h.

◆ WithDescription() [3/3]

Deployment& Aws::APIGateway::Model::Deployment::WithDescription ( const char *  value)
inline

The description for the deployment resource.

Definition at line 133 of file Deployment.h.

◆ WithId() [1/3]

Deployment& Aws::APIGateway::Model::Deployment::WithId ( const Aws::String value)
inline

The identifier for the deployment resource.

Definition at line 82 of file Deployment.h.

◆ WithId() [2/3]

Deployment& Aws::APIGateway::Model::Deployment::WithId ( Aws::String &&  value)
inline

The identifier for the deployment resource.

Definition at line 87 of file Deployment.h.

◆ WithId() [3/3]

Deployment& Aws::APIGateway::Model::Deployment::WithId ( const char *  value)
inline

The identifier for the deployment resource.

Definition at line 92 of file Deployment.h.


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