Class: Aws::APIGateway::Types::Deployment

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-apigateway/types.rb

Overview

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.

<div class=“remarks”> 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`). </div>

<div class=“seeAlso”> RestApi, Deployments, Stage, [AWS CLI], [AWS SDKs] </div>

[1]: docs.aws.amazon.com/cli/latest/reference/apigateway/get-deployment.html [2]: aws.amazon.com/tools/

Instance Attribute Summary collapse

Instance Attribute Details

#api_summary ⇒ Hash<String,Hash<String,Types::MethodSnapshot>>

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

Returns:



1769
1770
1771
1772
1773
1774
1775
 
# File 'lib/aws-sdk-apigateway/types.rb', line 1769

class Deployment < Struct.new(
  :id,
  :description,
  :created_date,
  :api_summary)
  include Aws::Structure
end

#created_date ⇒ Time

The date and time that the deployment resource was created.

Returns:

  • (Time) 


1769
1770
1771
1772
1773
1774
1775
 
# File 'lib/aws-sdk-apigateway/types.rb', line 1769

class Deployment < Struct.new(
  :id,
  :description,
  :created_date,
  :api_summary)
  include Aws::Structure
end

#description ⇒ String

The description for the deployment resource.

Returns:

  • (String) 


1769
1770
1771
1772
1773
1774
1775
 
# File 'lib/aws-sdk-apigateway/types.rb', line 1769

class Deployment < Struct.new(
  :id,
  :description,
  :created_date,
  :api_summary)
  include Aws::Structure
end

#id ⇒ String

The identifier for the deployment resource.

Returns:

  • (String) 


1769
1770
1771
1772
1773
1774
1775
 
# File 'lib/aws-sdk-apigateway/types.rb', line 1769

class Deployment < Struct.new(
  :id,
  :description,
  :created_date,
  :api_summary)
  include Aws::Structure
end