Class: Aws::MainframeModernization::Types::CreateEnvironmentRequest

Inherits:

Struct

• Object
• Struct
• Aws::MainframeModernization::Types::CreateEnvironmentRequest

Includes:

Structure

Defined in:

lib/aws-sdk-mainframemodernization/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_token ⇒ String

  Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create an environment.

• #description ⇒ String

  The description of the runtime environment.

• #engine_type ⇒ String

  The engine type for the runtime environment.

• #engine_version ⇒ String

  The version of the engine type for the runtime environment.

• #high_availability_config ⇒ Types::HighAvailabilityConfig

  The details of a high availability configuration for this runtime environment.

• #instance_type ⇒ String

  The type of instance for the runtime environment.

• #kms_key_id ⇒ String

  The identifier of a customer managed key.

• #name ⇒ String

  The name of the runtime environment.

• #preferred_maintenance_window ⇒ String

  Configures the maintenance window that you want for the runtime environment.

• #publicly_accessible ⇒ Boolean

  Specifies whether the runtime environment is publicly accessible.

• #security_group_ids ⇒ Array<String>

  The list of security groups for the VPC associated with this runtime environment.

• #storage_configurations ⇒ Array<Types::StorageConfiguration>

  Optional.

• #subnet_ids ⇒ Array<String>

  The list of subnets associated with the VPC for this runtime environment.

• #tags ⇒ Hash<String,String>

  The tags for the runtime environment.

Instance Attribute Details

#client_token ⇒ String

Unique, case-sensitive identifier you provide to ensure the idempotency of the request to create an environment. The service generates the clientToken when the API call is triggered. The token expires after one hour, so if you retry the API within this timeframe with the same clientToken, you will get the same response. The service also handles deleting the clientToken after it expires.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

• (String)

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

class CreateEnvironmentRequest < Struct.new(
  :client_token,
  :description,
  :engine_type,
  :engine_version,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :name,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :storage_configurations,
  :subnet_ids,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description of the runtime environment.

Returns:

• (String)

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

class CreateEnvironmentRequest < Struct.new(
  :client_token,
  :description,
  :engine_type,
  :engine_version,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :name,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :storage_configurations,
  :subnet_ids,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#engine_type ⇒ String

The engine type for the runtime environment.

Returns:

• (String)

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

class CreateEnvironmentRequest < Struct.new(
  :client_token,
  :description,
  :engine_type,
  :engine_version,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :name,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :storage_configurations,
  :subnet_ids,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#engine_version ⇒ String

The version of the engine type for the runtime environment.

Returns:

• (String)

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

class CreateEnvironmentRequest < Struct.new(
  :client_token,
  :description,
  :engine_type,
  :engine_version,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :name,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :storage_configurations,
  :subnet_ids,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#high_availability_config ⇒ Types::HighAvailabilityConfig

The details of a high availability configuration for this runtime environment.

Returns:

• (Types::HighAvailabilityConfig)

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

class CreateEnvironmentRequest < Struct.new(
  :client_token,
  :description,
  :engine_type,
  :engine_version,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :name,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :storage_configurations,
  :subnet_ids,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#instance_type ⇒ String

The type of instance for the runtime environment.

Returns:

• (String)

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

class CreateEnvironmentRequest < Struct.new(
  :client_token,
  :description,
  :engine_type,
  :engine_version,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :name,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :storage_configurations,
  :subnet_ids,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

The identifier of a customer managed key.

Returns:

• (String)

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

class CreateEnvironmentRequest < Struct.new(
  :client_token,
  :description,
  :engine_type,
  :engine_version,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :name,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :storage_configurations,
  :subnet_ids,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

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

Returns:

• (String)

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

class CreateEnvironmentRequest < Struct.new(
  :client_token,
  :description,
  :engine_type,
  :engine_version,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :name,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :storage_configurations,
  :subnet_ids,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_maintenance_window ⇒ String

Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format ‘ddd:hh24:mi-ddd:hh24:mi` and must be less than 24 hours. The following two examples are valid maintenance windows: `sun:23:45-mon:00:15` or `sat:01:00-sat:03:00`.

If you do not provide a value, a random system-generated value will be assigned.

Returns:

• (String)

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

class CreateEnvironmentRequest < Struct.new(
  :client_token,
  :description,
  :engine_type,
  :engine_version,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :name,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :storage_configurations,
  :subnet_ids,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#publicly_accessible ⇒ Boolean

Specifies whether the runtime environment is publicly accessible.

Returns:

• (Boolean)

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

class CreateEnvironmentRequest < Struct.new(
  :client_token,
  :description,
  :engine_type,
  :engine_version,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :name,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :storage_configurations,
  :subnet_ids,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_ids ⇒ Array<String>

The list of security groups for the VPC associated with this runtime environment.

Returns:

• (Array<String>)

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

class CreateEnvironmentRequest < Struct.new(
  :client_token,
  :description,
  :engine_type,
  :engine_version,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :name,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :storage_configurations,
  :subnet_ids,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#storage_configurations ⇒ Array<Types::StorageConfiguration>

Optional. The storage configurations for this runtime environment.

Returns:

• (Array<Types::StorageConfiguration>)

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

class CreateEnvironmentRequest < Struct.new(
  :client_token,
  :description,
  :engine_type,
  :engine_version,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :name,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :storage_configurations,
  :subnet_ids,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_ids ⇒ Array<String>

The list of subnets associated with the VPC for this runtime environment.

Returns:

• (Array<String>)

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

class CreateEnvironmentRequest < Struct.new(
  :client_token,
  :description,
  :engine_type,
  :engine_version,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :name,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :storage_configurations,
  :subnet_ids,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags for the runtime environment.

Returns:

• (Hash<String,String>)

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

class CreateEnvironmentRequest < Struct.new(
  :client_token,
  :description,
  :engine_type,
  :engine_version,
  :high_availability_config,
  :instance_type,
  :kms_key_id,
  :name,
  :preferred_maintenance_window,
  :publicly_accessible,
  :security_group_ids,
  :storage_configurations,
  :subnet_ids,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end