| ec2_modify_instance_attribute {aws.ecx} | R Documentation |
Modify Instance Attribute
Description
Modify Instance Attribute
Usage
ec2_modify_instance_attribute(
InstanceId,
SourceDestCheck = NULL,
Attribute = NULL,
BlockDeviceMapping = NULL,
DisableApiTermination = NULL,
DryRun = NULL,
EbsOptimized = NULL,
EnaSupport = NULL,
GroupId = NULL,
InstanceInitiatedShutdownBehavior = NULL,
InstanceType = NULL,
Kernel = NULL,
Ramdisk = NULL,
SriovNetSupport = NULL,
UserData = NULL,
Value = 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. |
SourceDestCheck |
Object. Specifies whether source/destination checking is enabled.[optional] |
Attribute |
Character. The name of the attribute.[optional] |
BlockDeviceMapping |
List. Modifies the |
DisableApiTermination |
Object. If the value is |
DryRun |
Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional] |
EbsOptimized |
Object. Specifies whether the instance is optimized for Amazon EBS I/O.[optional] |
EnaSupport |
Object. Set to |
GroupId |
List. [EC2-VPC] Changes the security groups of the instance.[optional] |
InstanceInitiatedShutdownBehavior |
Object. Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown)....[optional] |
InstanceType |
Object. Changes the instance type to the specified value.[optional] |
Kernel |
Object. Changes the instance\'s kernel to the specified value.[optional] |
Ramdisk |
Object. Changes the instance\'s RAM disk to the specified value.[optional] |
SriovNetSupport |
Object. Set to |
UserData |
Object. Changes the instance\'s user data to the specified value.[optional] |
Value |
Character. A new value for the attribute.[optional] |
simplify |
Logical. Whether to simplify the result and handle |
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 |
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.
SourceDestCheck
Specifies whether source/destination
checking is enabled. A value of true means that checking is enabled,
and false means that checking is disabled. This value must be false
for a NAT instance to perform NAT.
Attribute
The name of the attribute.
BlockDeviceMapping
Modifies the DeleteOnTermination attribute for volumes that are
currently attached. The volume must be owned by the caller. If no value
is specified for DeleteOnTermination, the default is true and the
volume is deleted when the instance is terminated.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the block device mapping when launching an instance in the Amazon EC2 User Guide.
DisableApiTermination
If the value is true, you can\'t terminate the
instance using the Amazon EC2 console, CLI, or API; otherwise, you can.
You cannot use this parameter for Spot
Instances.
DryRun
Checks whether you have the required
permissions for the action, without actually making the request, and
provides an error response. If you have the required permissions, the
error response is DryRunOperation. Otherwise, it is
UnauthorizedOperation.
EbsOptimized
Specifies whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn\'t available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
EnaSupport
Set to true to enable enhanced networking with ENA for the instance.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
GroupId
[EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it\'s just the default security group for the VPC. You must specify the security group ID, not the security group name.
InstanceInitiatedShutdownBehavior
Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
InstanceType
Changes the instance type to the
specified value. For more information, see Instance types
in the Amazon EC2 User Guide. If the instance type is not valid, the
error returned is
InvalidInstanceAttributeValue.
Kernel
Changes the instance\'s kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
Ramdisk
Changes the instance\'s RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.
SriovNetSupport
Set to simple to enable enhanced networking with the Intel 82599
Virtual Function interface for the instance.
There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
UserData
Changes the instance\'s user data to the specified value. If you are using an AWS SDK or command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text.
Value
A new value
for the attribute. Use only with the kernel, ramdisk, userData,
disableApiTermination, or instanceInitiatedShutdownBehavior
attribute.