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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

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, AWS SDKs

Returned by:

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:

  • (Hash<String,Hash<String,Types::MethodSnapshot>>) —

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

#created_date ⇒ Time

The date and time that the deployment resource was created.

Returns:

  • (Time) —

    The date and time that the deployment resource was created.

#description ⇒ String

The description for the deployment resource.

Returns:

  • (String) —

    The description for the deployment resource.

#id ⇒ String

The identifier for the deployment resource.

Returns:

  • (String) —

    The identifier for the deployment resource.