aws.ecx (version 1.0.5)

ec2_modify_instance_placement: Modify Instance Placement

Description

Modify Instance Placement

Usage

ec2_modify_instance_placement(
  InstanceId,
  Affinity = NULL,
  GroupName = NULL,
  HostId = NULL,
  Tenancy = NULL,
  PartitionNumber = NULL,
  HostResourceGroupArn = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

InstanceId

Character. The ID of the instance that you are modifying.

Affinity

Character. The affinity setting for the instance.[optional]

GroupName

Character. The name of the placement group in which to place the instance.[optional]

HostId

Character. The ID of the Dedicated Host with which to associate the instance.[optional]

Tenancy

Character. The tenancy for the instance.[optional]

PartitionNumber

Integer. Reserved for future use.[optional]

HostResourceGroupArn

Character. The ARN of the host resource group in which to place the instance.[optional]

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

Value

A list object or a character vector

InstanceId

The ID of the instance that you are modifying.

Affinity

The affinity setting for the instance.

GroupName

The name of the placement group in which to place the instance. For spread placement groups, the instance must have a tenancy of default. For cluster and partition placement groups, the instance must have a tenancy of default or dedicated.

To remove an instance from a placement group, specify an empty string (\'\').

HostId

The ID of the Dedicated Host with which to associate the instance.

Tenancy

The tenancy for the instance.

PartitionNumber

Reserved for future use.

HostResourceGroupArn

The ARN of the host resource group in which to place the instance.