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

Inherits:

Struct

• Object
• Struct
• Aws::ApiGatewayV2::Types::Deployment

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.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #auto_deployed ⇒ Boolean

  Specifies whether a deployment was automatically released.

• #created_date ⇒ Time

  The date and time when the Deployment resource was created.

• #deployment_id ⇒ String

  The identifier for the deployment.

• #deployment_status ⇒ String

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

• #deployment_status_message ⇒ String

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

• #description ⇒ String

  The description for the deployment.

Instance Attribute Details

#auto_deployed ⇒ Boolean

Specifies whether a deployment was automatically released.

Returns:

• (Boolean)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2973

class Deployment < Struct.new(
  :auto_deployed,
  :created_date,
  :deployment_id,
  :deployment_status,
  :deployment_status_message,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#created_date ⇒ Time

The date and time when the Deployment resource was created.

Returns:

• (Time)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2973

class Deployment < Struct.new(
  :auto_deployed,
  :created_date,
  :deployment_id,
  :deployment_status,
  :deployment_status_message,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_id ⇒ String

The identifier for the deployment.

Returns:

• (String)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2973

class Deployment < Struct.new(
  :auto_deployed,
  :created_date,
  :deployment_id,
  :deployment_status,
  :deployment_status_message,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_status ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2973

class Deployment < Struct.new(
  :auto_deployed,
  :created_date,
  :deployment_id,
  :deployment_status,
  :deployment_status_message,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_status_message ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2973

class Deployment < Struct.new(
  :auto_deployed,
  :created_date,
  :deployment_id,
  :deployment_status,
  :deployment_status_message,
  :description)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description for the deployment.

Returns:

• (String)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2973

class Deployment < Struct.new(
  :auto_deployed,
  :created_date,
  :deployment_id,
  :deployment_status,
  :deployment_status_message,
  :description)
  SENSITIVE = []
  include Aws::Structure
end