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

Class: Aws::ApiGatewayV2::Types::Deployment

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb

Overview

An immutable representation of an API that can be called by users. A Deployment must be associated with a Stage for it to be callable over the internet.

Instance Attribute Summary collapse

Instance Attribute Details

#created_dateTime

The date and time when the Deployment resource was created.

Returns:

  • (Time)


2448
2449
2450
2451
2452
2453
2454
2455
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2448

class Deployment < Struct.new(
  :created_date,
  :deployment_id,
  :deployment_status,
  :deployment_status_message,
  :description)
  include Aws::Structure
end

#deployment_idString

The identifier for the deployment.

Returns:

  • (String)


2448
2449
2450
2451
2452
2453
2454
2455
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2448

class Deployment < Struct.new(
  :created_date,
  :deployment_id,
  :deployment_status,
  :deployment_status_message,
  :description)
  include Aws::Structure
end

#deployment_statusString

The status of the deployment: PENDING, FAILED, or SUCCEEDED.

Returns:

  • (String)


2448
2449
2450
2451
2452
2453
2454
2455
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2448

class Deployment < Struct.new(
  :created_date,
  :deployment_id,
  :deployment_status,
  :deployment_status_message,
  :description)
  include Aws::Structure
end

#deployment_status_messageString

May contain additional feedback on the status of an API deployment.

Returns:

  • (String)


2448
2449
2450
2451
2452
2453
2454
2455
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2448

class Deployment < Struct.new(
  :created_date,
  :deployment_id,
  :deployment_status,
  :deployment_status_message,
  :description)
  include Aws::Structure
end

#descriptionString

The description for the deployment.

Returns:

  • (String)


2448
2449
2450
2451
2452
2453
2454
2455
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2448

class Deployment < Struct.new(
  :created_date,
  :deployment_id,
  :deployment_status,
  :deployment_status_message,
  :description)
  include Aws::Structure
end