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
- Struct
- Aws::SMS::Types::ServerLaunchConfiguration
 
- Defined in:
- (unknown)
Overview
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
- 
  
    
      #associate_public_ip_address  ⇒ Boolean 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    Indicates whether a publicly accessible IP address is created when launching the server. 
- 
  
    
      #configure_script  ⇒ Types::S3Location 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    Location of an Amazon S3 object. . 
- 
  
    
      #configure_script_type  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    The type of configuration script. 
- 
  
    
      #ec2_key_name  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    The name of the Amazon EC2 SSH key to be used for connecting to the launched server. 
- 
  
    
      #iam_instance_profile_name  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    The name of the IAM instance profile. 
- 
  
    
      #instance_type  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    The instance type to use when launching the server. 
- 
  
    
      #logical_id  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    The logical ID of the server in the AWS CloudFormation template. 
- 
  
    
      #security_group  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    The ID of the security group that applies to the launched server. 
- 
  
    
      #server  ⇒ Types::Server 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    The ID of the server with which the launch configuration is associated. 
- 
  
    
      #subnet  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    The ID of the subnet the server should be launched into. 
- 
  
    
      #user_data  ⇒ Types::UserData 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    Location of the user-data script to be executed when launching the server. 
- 
  
    
      #vpc  ⇒ String 
    
    
  
  
  
  
    
    
  
  
  
  
  
  
    The ID of the VPC into which the server should be launched. 
Instance Attribute Details
#associate_public_ip_address ⇒ Boolean
Indicates whether a publicly accessible IP address is created when launching the server.
#configure_script ⇒ Types::S3Location
Location of an Amazon S3 object.
#configure_script_type ⇒ String
The type of configuration script.
Possible values:
- SHELL_SCRIPT
- POWERSHELL_SCRIPT
#ec2_key_name ⇒ String
The name of the Amazon EC2 SSH key to be used for connecting to the launched server.
#iam_instance_profile_name ⇒ String
The name of the IAM instance profile.
#instance_type ⇒ String
The instance type to use when launching the server.
#logical_id ⇒ String
The logical ID of the server in the AWS CloudFormation template.
#security_group ⇒ String
The ID of the security group that applies to the launched server.
#server ⇒ Types::Server
The ID of the server with which the launch configuration is associated.
#subnet ⇒ String
The ID of the subnet the server should be launched into.
#user_data ⇒ Types::UserData
Location of the user-data script to be executed when launching the server.
#vpc ⇒ String
The ID of the VPC into which the server should be launched.