Class: Aws::MainframeModernization::Types::GetEnvironmentResponse

Inherits:

Struct

• Object
• Struct
• Aws::MainframeModernization::Types::GetEnvironmentResponse

Defined in:

gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #actual_capacity ⇒ Integer

  The number of instances included in the runtime environment.

• #creation_time ⇒ Time

  The timestamp when the runtime environment was created.

• #description ⇒ String

  The description of the runtime environment.

• #engine_type ⇒ String

  The target platform for the runtime environment.

• #engine_version ⇒ String

  The version of the runtime engine.

• #environment_arn ⇒ String

  The Amazon Resource Name (ARN) of the runtime environment.

• #environment_id ⇒ String

  The unique identifier of the runtime environment.

• #high_availability_config ⇒ Types::HighAvailabilityConfig

  The desired capacity of the high availability configuration for the runtime environment.

• #instance_type ⇒ String

  The type of instance underlying the runtime environment.

• #kms_key_id ⇒ String

  The identifier of a customer managed key.

• #load_balancer_arn ⇒ String

  The Amazon Resource Name (ARN) for the load balancer used with the runtime environment.

• #name ⇒ String

  The name of the runtime environment.

• #network_type ⇒ String

  The network type supported by the runtime environment.

• #pending_maintenance ⇒ Types::PendingMaintenance

  Indicates the pending maintenance scheduled on this environment.

• #preferred_maintenance_window ⇒ String

  The maintenance window for the runtime environment.

• #publicly_accessible ⇒ Boolean

  Whether applications running in this runtime environment are publicly accessible.

• #security_group_ids ⇒ Array<String>

  The unique identifiers of the security groups assigned to this runtime environment.

• #status ⇒ String

  The status of the runtime environment.

• #status_reason ⇒ String

  The reason for the reported status.

• #storage_configurations ⇒ Array<Types::StorageConfiguration>

  The storage configurations defined for the runtime environment.

• #subnet_ids ⇒ Array<String>

  The unique identifiers of the subnets assigned to this runtime environment.

• #tags ⇒ Hash<String,String>

  The tags defined for this runtime environment.

• #vpc_id ⇒ String

  The unique identifier for the VPC used with this runtime environment.

Instance Attribute Details

#actual_capacity ⇒ Integer

The number of instances included in the runtime environment. A standalone runtime environment has a maximum of one instance. Currently, a high availability runtime environment has a maximum of two instances.

Returns:

• (Integer)

# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 2094

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :load_balancer_arn,
  :name,
  :network_type,
  :pending_maintenance,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :status_reason,
  :storage_configurations,
  :subnet_ids,
  :tags,
  :vpc_id)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

The timestamp when the runtime environment was created.

Returns:

• (Time)

# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 2094

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :load_balancer_arn,
  :name,
  :network_type,
  :pending_maintenance,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :status_reason,
  :storage_configurations,
  :subnet_ids,
  :tags,
  :vpc_id)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the runtime environment.

Returns:

• (String)

# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 2094

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :load_balancer_arn,
  :name,
  :network_type,
  :pending_maintenance,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :status_reason,
  :storage_configurations,
  :subnet_ids,
  :tags,
  :vpc_id)
  SENSITIVE = []
  include Aws::Structure
end

#engine_type ⇒ String

The target platform for the runtime environment.

Returns:

• (String)

# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 2094

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :load_balancer_arn,
  :name,
  :network_type,
  :pending_maintenance,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :status_reason,
  :storage_configurations,
  :subnet_ids,
  :tags,
  :vpc_id)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ String

The version of the runtime engine.

Returns:

• (String)

# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 2094

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :load_balancer_arn,
  :name,
  :network_type,
  :pending_maintenance,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :status_reason,
  :storage_configurations,
  :subnet_ids,
  :tags,
  :vpc_id)
  SENSITIVE = []
  include Aws::Structure
end

#environment_arn ⇒ String

The Amazon Resource Name (ARN) of the runtime environment.

Returns:

• (String)

# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 2094

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :load_balancer_arn,
  :name,
  :network_type,
  :pending_maintenance,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :status_reason,
  :storage_configurations,
  :subnet_ids,
  :tags,
  :vpc_id)
  SENSITIVE = []
  include Aws::Structure
end

#environment_id ⇒ String

The unique identifier of the runtime environment.

Returns:

• (String)

# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 2094

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :load_balancer_arn,
  :name,
  :network_type,
  :pending_maintenance,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :status_reason,
  :storage_configurations,
  :subnet_ids,
  :tags,
  :vpc_id)
  SENSITIVE = []
  include Aws::Structure
end

#high_availability_config ⇒ Types::HighAvailabilityConfig

The desired capacity of the high availability configuration for the runtime environment.

Returns:

• (Types::HighAvailabilityConfig)

# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 2094

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :load_balancer_arn,
  :name,
  :network_type,
  :pending_maintenance,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :status_reason,
  :storage_configurations,
  :subnet_ids,
  :tags,
  :vpc_id)
  SENSITIVE = []
  include Aws::Structure
end

#instance_type ⇒ String

The type of instance underlying the runtime environment.

Returns:

• (String)

# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 2094

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :load_balancer_arn,
  :name,
  :network_type,
  :pending_maintenance,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :status_reason,
  :storage_configurations,
  :subnet_ids,
  :tags,
  :vpc_id)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

The identifier of a customer managed key.

Returns:

• (String)

# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 2094

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :load_balancer_arn,
  :name,
  :network_type,
  :pending_maintenance,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :status_reason,
  :storage_configurations,
  :subnet_ids,
  :tags,
  :vpc_id)
  SENSITIVE = []
  include Aws::Structure
end

#load_balancer_arn ⇒ String

The Amazon Resource Name (ARN) for the load balancer used with the runtime environment.

Returns:

• (String)

# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 2094

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :load_balancer_arn,
  :name,
  :network_type,
  :pending_maintenance,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :status_reason,
  :storage_configurations,
  :subnet_ids,
  :tags,
  :vpc_id)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the runtime environment. Must be unique within the account.

Returns:

• (String)

# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 2094

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :load_balancer_arn,
  :name,
  :network_type,
  :pending_maintenance,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :status_reason,
  :storage_configurations,
  :subnet_ids,
  :tags,
  :vpc_id)
  SENSITIVE = []
  include Aws::Structure
end

#network_type ⇒ String

The network type supported by the runtime environment.

Returns:

• (String)

# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 2094

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :load_balancer_arn,
  :name,
  :network_type,
  :pending_maintenance,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :status_reason,
  :storage_configurations,
  :subnet_ids,
  :tags,
  :vpc_id)
  SENSITIVE = []
  include Aws::Structure
end

#pending_maintenance ⇒ Types::PendingMaintenance

Indicates the pending maintenance scheduled on this environment.

Returns:

• (Types::PendingMaintenance)

# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 2094

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :load_balancer_arn,
  :name,
  :network_type,
  :pending_maintenance,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :status_reason,
  :storage_configurations,
  :subnet_ids,
  :tags,
  :vpc_id)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_maintenance_window ⇒ String

The maintenance window for the runtime environment. If you don't provide a value for the maintenance window, the service assigns a random value.

Returns:

• (String)

# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 2094

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :load_balancer_arn,
  :name,
  :network_type,
  :pending_maintenance,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :status_reason,
  :storage_configurations,
  :subnet_ids,
  :tags,
  :vpc_id)
  SENSITIVE = []
  include Aws::Structure
end

#publicly_accessible ⇒ Boolean

Whether applications running in this runtime environment are publicly accessible.

Returns:

• (Boolean)

# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 2094

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :load_balancer_arn,
  :name,
  :network_type,
  :pending_maintenance,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :status_reason,
  :storage_configurations,
  :subnet_ids,
  :tags,
  :vpc_id)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_ids ⇒ Array<String>

The unique identifiers of the security groups assigned to this runtime environment.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 2094

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :load_balancer_arn,
  :name,
  :network_type,
  :pending_maintenance,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :status_reason,
  :storage_configurations,
  :subnet_ids,
  :tags,
  :vpc_id)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the runtime environment. If the Amazon Web Services Mainframe Modernization environment is missing a connection to the customer owned dependent resource, the status will be Unhealthy.

Returns:

• (String)

# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 2094

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :load_balancer_arn,
  :name,
  :network_type,
  :pending_maintenance,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :status_reason,
  :storage_configurations,
  :subnet_ids,
  :tags,
  :vpc_id)
  SENSITIVE = []
  include Aws::Structure
end

#status_reason ⇒ String

The reason for the reported status.

Returns:

• (String)

# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 2094

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :load_balancer_arn,
  :name,
  :network_type,
  :pending_maintenance,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :status_reason,
  :storage_configurations,
  :subnet_ids,
  :tags,
  :vpc_id)
  SENSITIVE = []
  include Aws::Structure
end

#storage_configurations ⇒ Array<Types::StorageConfiguration>

The storage configurations defined for the runtime environment.

Returns:

• (Array<Types::StorageConfiguration>)

# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 2094

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :load_balancer_arn,
  :name,
  :network_type,
  :pending_maintenance,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :status_reason,
  :storage_configurations,
  :subnet_ids,
  :tags,
  :vpc_id)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_ids ⇒ Array<String>

The unique identifiers of the subnets assigned to this runtime environment.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 2094

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :load_balancer_arn,
  :name,
  :network_type,
  :pending_maintenance,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :status_reason,
  :storage_configurations,
  :subnet_ids,
  :tags,
  :vpc_id)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags defined for this runtime environment.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 2094

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :load_balancer_arn,
  :name,
  :network_type,
  :pending_maintenance,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :status_reason,
  :storage_configurations,
  :subnet_ids,
  :tags,
  :vpc_id)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ String

The unique identifier for the VPC used with this runtime environment.

Returns:

• (String)

# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 2094

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :load_balancer_arn,
  :name,
  :network_type,
  :pending_maintenance,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :status,
  :status_reason,
  :storage_configurations,
  :subnet_ids,
  :tags,
  :vpc_id)
  SENSITIVE = []
  include Aws::Structure
end