AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ServerLaunchConfiguration as input to an Aws::Client method, you can use a vanilla 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.

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)

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

#configure_scriptTypes::S3Location

Location of an Amazon S3 object.

Returns:

#configure_script_typeString

The type of configuration script.

Possible values:

  • SHELL_SCRIPT
  • POWERSHELL_SCRIPT

Returns:

  • (String)

    The type of configuration script.

#ec2_key_nameString

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

Returns:

  • (String)

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

#iam_instance_profile_nameString

The name of the IAM instance profile.

Returns:

  • (String)

    The name of the IAM instance profile.

#instance_typeString

The instance type to use when launching the server.

Returns:

  • (String)

    The instance type to use when launching the server.

#logical_idString

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

Returns:

  • (String)

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

#security_groupString

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

Returns:

  • (String)

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

#serverTypes::Server

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

Returns:

  • (Types::Server)

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

#subnetString

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

Returns:

  • (String)

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

#user_dataTypes::UserData

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

Returns:

  • (Types::UserData)

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

#vpcString

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

Returns:

  • (String)

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