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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#actual_capacityInteger

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

Returns:

  • (Integer)


1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 1716

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :load_balancer_arn,
  :name,
  :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_timeTime

The timestamp when the runtime environment was created.

Returns:

  • (Time)


1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 1716

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :load_balancer_arn,
  :name,
  :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

#descriptionString

The description of the runtime environment.

Returns:

  • (String)


1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 1716

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :load_balancer_arn,
  :name,
  :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_typeString

The target platform for the runtime environment.

Returns:

  • (String)


1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 1716

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :load_balancer_arn,
  :name,
  :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_versionString

The version of the runtime engine.

Returns:

  • (String)


1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 1716

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :load_balancer_arn,
  :name,
  :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_arnString

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

Returns:

  • (String)


1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 1716

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :load_balancer_arn,
  :name,
  :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_idString

The unique identifier of the runtime environment.

Returns:

  • (String)


1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 1716

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :load_balancer_arn,
  :name,
  :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_configTypes::HighAvailabilityConfig

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



1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 1716

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :load_balancer_arn,
  :name,
  :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_typeString

The type of instance underlying the runtime environment.

Returns:

  • (String)


1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 1716

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :load_balancer_arn,
  :name,
  :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_arnString

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

Returns:

  • (String)


1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 1716

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :load_balancer_arn,
  :name,
  :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

#nameString

The name of the runtime environment.

Returns:

  • (String)


1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 1716

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :load_balancer_arn,
  :name,
  :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_maintenanceTypes::PendingMaintenance

Indicates the pending maintenance scheduled on this environment.



1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 1716

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :load_balancer_arn,
  :name,
  :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_windowString

Configures a desired maintenance window for the environment. If you do not provide a value, a random system-generated value will be assigned.

Returns:

  • (String)


1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 1716

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :load_balancer_arn,
  :name,
  :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_accessibleBoolean

Whether applications running in this runtime environment are publicly accessible.

Returns:

  • (Boolean)


1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 1716

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :load_balancer_arn,
  :name,
  :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_idsArray<String>

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

Returns:

  • (Array<String>)


1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 1716

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :load_balancer_arn,
  :name,
  :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

#statusString

The status of the runtime environment.

Returns:

  • (String)


1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 1716

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :load_balancer_arn,
  :name,
  :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_reasonString

The reason for the reported status.

Returns:

  • (String)


1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 1716

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :load_balancer_arn,
  :name,
  :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_configurationsArray<Types::StorageConfiguration>

The storage configurations defined for the runtime environment.

Returns:



1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 1716

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :load_balancer_arn,
  :name,
  :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_idsArray<String>

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

Returns:

  • (Array<String>)


1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 1716

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :load_balancer_arn,
  :name,
  :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

#tagsHash<String,String>

The tags defined for this runtime environment.

Returns:

  • (Hash<String,String>)


1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 1716

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :load_balancer_arn,
  :name,
  :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_idString

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

Returns:

  • (String)


1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
# File 'gems/aws-sdk-mainframemodernization/lib/aws-sdk-mainframemodernization/types.rb', line 1716

class GetEnvironmentResponse < Struct.new(
  :actual_capacity,
  :creation_time,
  :description,
  :engine_type,
  :engine_version,
  :environment_arn,
  :environment_id,
  :high_availability_config,
  :instance_type,
  :load_balancer_arn,
  :name,
  :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