Class: Aws::SMS::Types::ServerLaunchConfiguration

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

Overview

Note:

When making an API call, you may pass ServerLaunchConfiguration data as a hash:

{
  server: {
    server_id: "ServerId",
    server_type: "VIRTUAL_MACHINE", # accepts VIRTUAL_MACHINE
    vm_server: {
      vm_server_address: {
        vm_manager_id: "VmManagerId",
        vm_id: "VmId",
      },
      vm_name: "VmName",
      vm_manager_name: "VmManagerName",
      vm_manager_type: "VSPHERE", # accepts VSPHERE, SCVMM, HYPERV-MANAGER
      vm_path: "VmPath",
    },
    replication_job_id: "ReplicationJobId",
    replication_job_terminated: false,
  },
  logical_id: "LogicalId",
  vpc: "VPC",
  subnet: "Subnet",
  security_group: "SecurityGroup",
  ec2_key_name: "EC2KeyName",
  user_data: {
    s3_location: {
      bucket: "S3BucketName",
      key: "S3KeyName",
    },
  },
  instance_type: "InstanceType",
  associate_public_ip_address: false,
  iam_instance_profile_name: "RoleName",
  configure_script: {
    bucket: "S3BucketName",
    key: "S3KeyName",
  },
  configure_script_type: "SHELL_SCRIPT", # accepts SHELL_SCRIPT, POWERSHELL_SCRIPT
}

Launch configuration for a server.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#associate_public_ip_addressBoolean

Indicates whether a publicly accessible IP address is created when launching the server.

Returns:

  • (Boolean)


2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 2359

class ServerLaunchConfiguration < Struct.new(
  :server,
  :logical_id,
  :vpc,
  :subnet,
  :security_group,
  :ec2_key_name,
  :user_data,
  :instance_type,
  :associate_public_ip_address,
  :iam_instance_profile_name,
  :configure_script,
  :configure_script_type)
  SENSITIVE = []
  include Aws::Structure
end

#configure_scriptTypes::S3Location

Location of an Amazon S3 object.

Returns:



2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 2359

class ServerLaunchConfiguration < Struct.new(
  :server,
  :logical_id,
  :vpc,
  :subnet,
  :security_group,
  :ec2_key_name,
  :user_data,
  :instance_type,
  :associate_public_ip_address,
  :iam_instance_profile_name,
  :configure_script,
  :configure_script_type)
  SENSITIVE = []
  include Aws::Structure
end

#configure_script_typeString

The type of configuration script.

Returns:

  • (String)


2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 2359

class ServerLaunchConfiguration < Struct.new(
  :server,
  :logical_id,
  :vpc,
  :subnet,
  :security_group,
  :ec2_key_name,
  :user_data,
  :instance_type,
  :associate_public_ip_address,
  :iam_instance_profile_name,
  :configure_script,
  :configure_script_type)
  SENSITIVE = []
  include Aws::Structure
end

#ec2_key_nameString

The name of the Amazon EC2 SSH key to be used for connecting to the launched server.

Returns:

  • (String)


2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 2359

class ServerLaunchConfiguration < Struct.new(
  :server,
  :logical_id,
  :vpc,
  :subnet,
  :security_group,
  :ec2_key_name,
  :user_data,
  :instance_type,
  :associate_public_ip_address,
  :iam_instance_profile_name,
  :configure_script,
  :configure_script_type)
  SENSITIVE = []
  include Aws::Structure
end

#iam_instance_profile_nameString

The name of the IAM instance profile.

Returns:

  • (String)


2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 2359

class ServerLaunchConfiguration < Struct.new(
  :server,
  :logical_id,
  :vpc,
  :subnet,
  :security_group,
  :ec2_key_name,
  :user_data,
  :instance_type,
  :associate_public_ip_address,
  :iam_instance_profile_name,
  :configure_script,
  :configure_script_type)
  SENSITIVE = []
  include Aws::Structure
end

#instance_typeString

The instance type to use when launching the server.

Returns:

  • (String)


2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 2359

class ServerLaunchConfiguration < Struct.new(
  :server,
  :logical_id,
  :vpc,
  :subnet,
  :security_group,
  :ec2_key_name,
  :user_data,
  :instance_type,
  :associate_public_ip_address,
  :iam_instance_profile_name,
  :configure_script,
  :configure_script_type)
  SENSITIVE = []
  include Aws::Structure
end

#logical_idString

The logical ID of the server in the AWS CloudFormation template.

Returns:

  • (String)


2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 2359

class ServerLaunchConfiguration < Struct.new(
  :server,
  :logical_id,
  :vpc,
  :subnet,
  :security_group,
  :ec2_key_name,
  :user_data,
  :instance_type,
  :associate_public_ip_address,
  :iam_instance_profile_name,
  :configure_script,
  :configure_script_type)
  SENSITIVE = []
  include Aws::Structure
end

#security_groupString

The ID of the security group that applies to the launched server.

Returns:

  • (String)


2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 2359

class ServerLaunchConfiguration < Struct.new(
  :server,
  :logical_id,
  :vpc,
  :subnet,
  :security_group,
  :ec2_key_name,
  :user_data,
  :instance_type,
  :associate_public_ip_address,
  :iam_instance_profile_name,
  :configure_script,
  :configure_script_type)
  SENSITIVE = []
  include Aws::Structure
end

#serverTypes::Server

The ID of the server with which the launch configuration is associated.

Returns:



2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 2359

class ServerLaunchConfiguration < Struct.new(
  :server,
  :logical_id,
  :vpc,
  :subnet,
  :security_group,
  :ec2_key_name,
  :user_data,
  :instance_type,
  :associate_public_ip_address,
  :iam_instance_profile_name,
  :configure_script,
  :configure_script_type)
  SENSITIVE = []
  include Aws::Structure
end

#subnetString

The ID of the subnet the server should be launched into.

Returns:

  • (String)


2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 2359

class ServerLaunchConfiguration < Struct.new(
  :server,
  :logical_id,
  :vpc,
  :subnet,
  :security_group,
  :ec2_key_name,
  :user_data,
  :instance_type,
  :associate_public_ip_address,
  :iam_instance_profile_name,
  :configure_script,
  :configure_script_type)
  SENSITIVE = []
  include Aws::Structure
end

#user_dataTypes::UserData

Location of the user-data script to be executed when launching the server.

Returns:



2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 2359

class ServerLaunchConfiguration < Struct.new(
  :server,
  :logical_id,
  :vpc,
  :subnet,
  :security_group,
  :ec2_key_name,
  :user_data,
  :instance_type,
  :associate_public_ip_address,
  :iam_instance_profile_name,
  :configure_script,
  :configure_script_type)
  SENSITIVE = []
  include Aws::Structure
end

#vpcString

The ID of the VPC into which the server should be launched.

Returns:

  • (String)


2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
# File 'gems/aws-sdk-sms/lib/aws-sdk-sms/types.rb', line 2359

class ServerLaunchConfiguration < Struct.new(
  :server,
  :logical_id,
  :vpc,
  :subnet,
  :security_group,
  :ec2_key_name,
  :user_data,
  :instance_type,
  :associate_public_ip_address,
  :iam_instance_profile_name,
  :configure_script,
  :configure_script_type)
  SENSITIVE = []
  include Aws::Structure
end