You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/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.

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][1], [AWS SDKs][2]

Instance Attribute Summary collapse

Instance Attribute Details

#api_summaryHash<String,Hash<String,Types::MethodSnapshot>>

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

Returns:



1699
1700
1701
1702
1703
1704
1705
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1699

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

#created_dateTime

The date and time that the deployment resource was created.

Returns:

  • (Time)


1699
1700
1701
1702
1703
1704
1705
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1699

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

#descriptionString

The description for the deployment resource.

Returns:

  • (String)


1699
1700
1701
1702
1703
1704
1705
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1699

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

#idString

The identifier for the deployment resource.

Returns:

  • (String)


1699
1700
1701
1702
1703
1704
1705
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1699

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