Common documents

Description

Common documents

Arguments

Value

No return value

Set or get AWS credentials

Description

Set or get AWS credentials. This function will be called by the package when loaded.

Usage

aws_set_credentials(
  key_file = NULL,
  access_key_id = NULL,
  secret_access_key = NULL,
  region = NULL,
  profile = NULL
)

aws_get_credentials()

aws_get_access_key_id()

aws_get_secret_access_key()

aws_get_region()

aws_set_access_key_id(access_key_id)

aws_set_secret_access_key(secret_access_key)

aws_set_region(region)

aws_list_regions()

Arguments

Details

The function aws_set_credentials uses aws.signature::locate_credentials internally to determine your credentials. There are a variety of ways to find the credentials, the most common methods are(sorted by the search order)

1. user-supplied values passed to the function

2. environment variables (AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_DEFAULT_REGION, and AWS_SESSION_TOKEN)

3. a profile in a local credentials dot file in the current working directory, using the profile specified by AWS_PROFILE

4. a profile in a global credentials dot file in a location set by AWS_SHARED_CREDENTIALS_FILE or defaulting typically to "⁠~/.aws/credentials⁠" (or another OS-specific location), using the profile specified by AWS_PROFILE

Value

aws_set_credentials : A list containing credentials(with asterisk) and region.

aws_get_credentials : A list containing credentials(with asterisk) and region.

aws_get_access_key_id : The access key id

aws_get_secret_access_key : The secret access key

aws_get_region : The region

aws_set_access_key_id : NULL

aws_set_secret_access_key : NULL

aws_set_region : The old region

aws_list_regions: A vector of available regions

Examples

## Get your credentials from the environment variables or AWS cli
aws_set_credentials()

## show your current credentials
aws_get_credentials()

Get or set the package settings

Description

Get or set the package settings

Usage

aws_set_retry_time(x)

aws_set_print_on_error(x)

aws_set_network_timeout(x)

aws_get_retry_time()

aws_get_print_on_error()

aws_get_network_timeout()

Arguments

Value

Setter: The old value Getter: The current value

Examples

## Set the timeout to 10 seconds
aws_set_network_timeout(10)
## Get the timeout setting
aws_get_network_timeout()

## Turn off print on error
aws_set_print_on_error(FALSE)

## Set the retry times to 5
aws_set_retry_time(5)

Accept Reserved Instances Exchange Quote

Description

Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.

Usage

ec2_accept_reserved_instances_exchange_quote(
  ReservedInstanceId,
  DryRun = NULL,
  TargetConfiguration = 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

Value

A list object or a character vector

ReservedInstanceId

The IDs of the Convertible Reserved Instances to exchange for another Convertible Reserved Instance of the same or higher value.

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.

TargetConfiguration

The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.

Accept Transit Gateway Multicast Domain Associations

Description

Accepts a request to associate subnets with a transit gateway multicast domain.

Usage

ec2_accept_transit_gateway_multicast_domain_associations(
  TransitGatewayMulticastDomainId = NULL,
  TransitGatewayAttachmentId = NULL,
  SubnetIds = NULL,
  DryRun = 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

Value

A list object or a character vector

TransitGatewayMulticastDomainId

The ID of the transit gateway multicast domain.

TransitGatewayAttachmentId

The ID of the transit gateway attachment.

SubnetIds

The IDs of the subnets to associate with the transit gateway multicast domain.

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.

Accept Transit Gateway Peering Attachment

Description

Accepts a transit gateway peering attachment request. The peering attachment must be in the pendingAcceptance state.

Usage

ec2_accept_transit_gateway_peering_attachment(
  TransitGatewayAttachmentId,
  DryRun = 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

Value

A list object or a character vector

TransitGatewayAttachmentId

The ID of the transit gateway attachment.

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.

Accept Transit Gateway Vpc Attachment

Description

Accept Transit Gateway Vpc Attachment

Usage

ec2_accept_transit_gateway_vpc_attachment(
  TransitGatewayAttachmentId,
  DryRun = 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

Value

A list object or a character vector

TransitGatewayAttachmentId

The ID of the attachment.

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.

Accept Vpc Endpoint Connections

Description

Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service.

Usage

ec2_accept_vpc_endpoint_connections(
  ServiceId,
  VpcEndpointId,
  DryRun = 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

Value

A list object or a character vector

ServiceId

The ID of the VPC endpoint service.

VpcEndpointId

The IDs of one or more interface VPC endpoints.

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.

Accept Vpc Peering Connection

Description

Accept Vpc Peering Connection

Usage

ec2_accept_vpc_peering_connection(
  DryRun = NULL,
  VpcPeeringConnectionId = 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

Value

A list object or a character vector

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.

VpcPeeringConnectionId

The ID of the VPC peering connection. You must specify this parameter in the request.

Advertise Byoip Cidr

Description

Advertise Byoip Cidr

Usage

ec2_advertise_byoip_cidr(
  Cidr,
  DryRun = 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

Value

A list object or a character vector

Cidr

The address range, in CIDR notation. This must be the exact range that you provisioned. You can\'t advertise only a portion of the provisioned range.

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.

Allocate Address

Description

Allocate Address

Usage

ec2_allocate_address(
  Domain = NULL,
  Address = NULL,
  PublicIpv4Pool = NULL,
  NetworkBorderGroup = NULL,
  CustomerOwnedIpv4Pool = NULL,
  DryRun = NULL,
  TagSpecification = 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

Value

A list object or a character vector

Domain

Indicates whether the Elastic IP address is for use with instances in a VPC or instances in EC2-Classic.

Default: If the Region supports EC2-Classic, the default is standard. Otherwise, the default is vpc.

Address

[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.

PublicIpv4Pool

The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. To specify a specific address from the address pool, use the Address parameter instead.

NetworkBorderGroup

A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.

Use DescribeAvailabilityZones to view the network border groups.

You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will receive an InvalidParameterCombination error. For more information, see Error Codes.

CustomerOwnedIpv4Pool

The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool.

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.

TagSpecification

The tags to assign to the Elastic IP address.

Allocate Hosts

Description

Allocates a Dedicated Host to your account. At a minimum, specify the supported instance type or instance family, the Availability Zone in which to allocate the host, and the number of hosts to allocate.

Usage

ec2_allocate_hosts(
  AvailabilityZone,
  Quantity,
  AutoPlacement = NULL,
  ClientToken = NULL,
  InstanceType = NULL,
  InstanceFamily = NULL,
  TagSpecification = NULL,
  HostRecovery = 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

Value

A list object or a character vector

AvailabilityZone

The Availability Zone in which to allocate the Dedicated Host.

Quantity

The number of Dedicated Hosts to allocate to your account with these parameters.

AutoPlacement

Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see Understanding auto-placement and affinity in the Amazon EC2 User Guide.

Default: on

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

InstanceType

Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only.

If you want the Dedicated Hosts to support multiple instance types in a specific instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.

InstanceFamily

Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family.

If you want the Dedicated Hosts to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.

TagSpecification

The tags to apply to the Dedicated Host during creation.

HostRecovery

Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see Host recovery in the Amazon EC2 User Guide.

Default: off

Apply Security Groups To Client Vpn Target Network

Description

Applies a security group to the association between the target network and the Client VPN endpoint. This action replaces the existing security groups with the specified security groups.

Usage

ec2_apply_security_groups_to_client_vpn_target_network(
  ClientVpnEndpointId,
  VpcId,
  SecurityGroupId,
  DryRun = 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

Value

A list object or a character vector

ClientVpnEndpointId

The ID of the Client VPN endpoint.

VpcId

The ID of the VPC in which the associated target network is located.

SecurityGroupId

The IDs of the security groups to apply to the associated target network. Up to 5 security groups can be applied to an associated target network.

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.

Assign Ipv6 Addresses

Description

Assign Ipv6 Addresses

Usage

ec2_assign_ipv6_addresses(
  NetworkInterfaceId,
  Ipv6AddressCount = NULL,
  Ipv6Addresses = 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

Value

A list object or a character vector

NetworkInterfaceId

The ID of the network interface.

Ipv6AddressCount

The number of additional IPv6 addresses to assign to the network interface. The specified number of IPv6 addresses are assigned in addition to the existing IPv6 addresses that are already assigned to the network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can\'t use this option if specifying specific IPv6 addresses.

Ipv6Addresses

One or more specific IPv6 addresses to be assigned to the network interface. You can\'t use this option if you\'re specifying a number of IPv6 addresses.

Assign Private Ip Addresses

Description

Assign Private Ip Addresses

Usage

ec2_assign_private_ip_addresses(
  NetworkInterfaceId,
  AllowReassignment = NULL,
  PrivateIpAddress = NULL,
  SecondaryPrivateIpAddressCount = 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

Value

A list object or a character vector

NetworkInterfaceId

The ID of the network interface.

AllowReassignment

Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface.

PrivateIpAddress

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can\'t specify this parameter when also specifying a number of secondary IP addresses.

If you don\'t specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

SecondaryPrivateIpAddressCount

The number of secondary IP addresses to assign to the network interface. You can\'t specify this parameter when also specifying private IP addresses.

Associate Address

Description

Associate Address

Usage

ec2_associate_address(
  AllocationId = NULL,
  InstanceId = NULL,
  PublicIp = NULL,
  AllowReassociation = NULL,
  DryRun = NULL,
  NetworkInterfaceId = NULL,
  PrivateIpAddress = 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

Value

A list object or a character vector

AllocationId

[EC2-VPC] The allocation ID. This is required for EC2-VPC.

InstanceId

The ID of the instance. The instance must have exactly one attached network interface. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. For EC2-Classic, you must specify an instance ID and the instance must be in the running state.

PublicIp

[EC2-Classic] The Elastic IP address to associate with the instance. This is required for EC2-Classic.

AllowReassociation

[EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails. In a VPC in an EC2-VPC-only account, reassociation is automatic, therefore you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.

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.

NetworkInterfaceId

[EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.

For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.

PrivateIpAddress

[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.

Associate Client Vpn Target Network

Description

Associate Client Vpn Target Network

Usage

ec2_associate_client_vpn_target_network(
  ClientVpnEndpointId,
  SubnetId,
  ClientToken = NULL,
  DryRun = 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

Value

A list object or a character vector

ClientVpnEndpointId

The ID of the Client VPN endpoint.

SubnetId

The ID of the subnet to associate with the Client VPN endpoint.

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

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.

Associate Dhcp Options

Description

Associate Dhcp Options

Usage

ec2_associate_dhcp_options(
  DhcpOptionsId,
  VpcId,
  DryRun = 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

Value

A list object or a character vector

DhcpOptionsId

The ID of the DHCP options set, or default to associate no DHCP options with the VPC.

VpcId

The ID of the VPC.

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.

Associate Enclave Certificate Iam Role

Description

Associate Enclave Certificate Iam Role

Usage

ec2_associate_enclave_certificate_iam_role(
  CertificateArn = NULL,
  RoleArn = NULL,
  DryRun = 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

Value

A list object or a character vector

CertificateArn

The ARN of the ACM certificate with which to associate the IAM role.

RoleArn

The ARN of the IAM role to associate with the ACM certificate. You can associate up to 16 IAM roles with an ACM certificate.

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.

Associate Iam Instance Profile

Description

Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance.

Usage

ec2_associate_iam_instance_profile(
  IamInstanceProfile,
  InstanceId,
  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

Value

A list object or a character vector

IamInstanceProfile

The IAM instance profile.

InstanceId

The ID of the instance.

Associate Route Table

Description

Associate Route Table

Usage

ec2_associate_route_table(
  RouteTableId,
  DryRun = NULL,
  SubnetId = NULL,
  GatewayId = 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

Value

A list object or a character vector

RouteTableId

The ID of the route table.

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.

SubnetId

The ID of the subnet.

GatewayId

The ID of the internet gateway or virtual private gateway.

Associate Subnet Cidr Block

Description

Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet. An IPv6 CIDR block must have a prefix length of /64.

Usage

ec2_associate_subnet_cidr_block(
  SubnetId,
  Ipv6CidrBlock,
  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

Value

A list object or a character vector

SubnetId

The ID of your subnet.

Ipv6CidrBlock

The IPv6 CIDR block for your subnet. The subnet must have a /64 prefix length.

Associate Transit Gateway Multicast Domain

Description

Associate Transit Gateway Multicast Domain

Usage

ec2_associate_transit_gateway_multicast_domain(
  TransitGatewayMulticastDomainId = NULL,
  TransitGatewayAttachmentId = NULL,
  SubnetIds = NULL,
  DryRun = 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

Value

A list object or a character vector

TransitGatewayMulticastDomainId

The ID of the transit gateway multicast domain.

TransitGatewayAttachmentId

The ID of the transit gateway attachment to associate with the transit gateway multicast domain.

SubnetIds

The IDs of the subnets to associate with the transit gateway multicast domain.

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.

Associate Transit Gateway Route Table

Description

Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.

Usage

ec2_associate_transit_gateway_route_table(
  TransitGatewayRouteTableId,
  TransitGatewayAttachmentId,
  DryRun = 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

Value

A list object or a character vector

TransitGatewayRouteTableId

The ID of the transit gateway route table.

TransitGatewayAttachmentId

The ID of the attachment.

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.

Associate Vpc Cidr Block

Description

Associate Vpc Cidr Block

Usage

ec2_associate_vpc_cidr_block(
  VpcId,
  AmazonProvidedIpv6CidrBlock = NULL,
  CidrBlock = NULL,
  Ipv6CidrBlockNetworkBorderGroup = NULL,
  Ipv6Pool = NULL,
  Ipv6CidrBlock = 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

Value

A list object or a character vector

VpcId

The ID of the VPC.

AmazonProvidedIpv6CidrBlock

Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IPv6 addresses, or the size of the CIDR block.

CidrBlock

An IPv4 CIDR block to associate with the VPC.

Ipv6CidrBlockNetworkBorderGroup

The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the CIDR block to this location.

You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.

You can have one IPv6 CIDR block association per network border group.

Ipv6Pool

The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.

Ipv6CidrBlock

An IPv6 CIDR block from the IPv6 address pool. You must also specify Ipv6Pool in the request.

To let Amazon choose the IPv6 CIDR block for you, omit this parameter.

Attach Classic Link Vpc

Description

Attach Classic Link Vpc

Usage

ec2_attach_classic_link_vpc(
  SecurityGroupId,
  InstanceId,
  VpcId,
  DryRun = 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

Value

A list object or a character vector

SecurityGroupId

The ID of one or more of the VPC\'s security groups. You cannot specify security groups from a different VPC.

InstanceId

The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.

VpcId

The ID of a ClassicLink-enabled VPC.

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.

Attach Internet Gateway

Description

Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.

Usage

ec2_attach_internet_gateway(
  InternetGatewayId,
  VpcId,
  DryRun = 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

Value

A list object or a character vector

InternetGatewayId

The ID of the internet gateway.

VpcId

The ID of the VPC.

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.

Attach Network Interface

Description

Attaches a network interface to an instance.

Usage

ec2_attach_network_interface(
  DeviceIndex,
  InstanceId,
  NetworkInterfaceId,
  DryRun = NULL,
  NetworkCardIndex = 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

Value

A list object or a character vector

DeviceIndex

The index of the device for the network interface attachment.

InstanceId

The ID of the instance.

NetworkInterfaceId

The ID of the network interface.

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.

NetworkCardIndex

The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.

Attach Volume

Description

Attach Volume

Usage

ec2_attach_volume(
  Device,
  InstanceId,
  VolumeId,
  DryRun = 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

Value

A list object or a character vector

Device

The device name (for example, ⁠/dev/sdh⁠ or xvdh).

InstanceId

The ID of the instance.

VolumeId

The ID of the EBS volume. The volume and instance must be within the same Availability Zone.

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.

Attach Vpn Gateway

Description

Attach Vpn Gateway

Usage

ec2_attach_vpn_gateway(
  VpcId,
  VpnGatewayId,
  DryRun = 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

Value

A list object or a character vector

VpcId

The ID of the VPC.

VpnGatewayId

The ID of the virtual private gateway.

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.

Authorize Client Vpn Ingress

Description

Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in AWS or on-premises networks.

Usage

ec2_authorize_client_vpn_ingress(
  ClientVpnEndpointId,
  TargetNetworkCidr,
  AccessGroupId = NULL,
  AuthorizeAllGroups = NULL,
  Description = NULL,
  ClientToken = NULL,
  DryRun = 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

Value

A list object or a character vector

ClientVpnEndpointId

The ID of the Client VPN endpoint.

TargetNetworkCidr

The IPv4 address range, in CIDR notation, of the network for which access is being authorized.

AccessGroupId

The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group. Required if AuthorizeAllGroups is false or not specified.

AuthorizeAllGroups

Indicates whether to grant access to all clients. Specify true to grant all clients who successfully establish a VPN connection access to the network. Must be set to true if AccessGroupId is not specified.

Description

A brief description of the authorization rule.

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

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.

Authorize Security Group Egress

Description

Authorize Security Group Egress

Usage

ec2_authorize_security_group_egress(
  GroupId,
  DryRun = NULL,
  IpPermissions = NULL,
  CidrIp = NULL,
  FromPort = NULL,
  IpProtocol = NULL,
  ToPort = NULL,
  SourceSecurityGroupName = NULL,
  SourceSecurityGroupOwnerId = 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

Value

A list object or a character vector

GroupId

The ID of the security group.

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.

IpPermissions

The sets of IP permissions. You can\'t specify a destination security group and a CIDR IP address range in the same set of permissions.

CidrIp

Not supported. Use a set of IP permissions to specify the CIDR.

FromPort

Not supported. Use a set of IP permissions to specify the port.

IpProtocol

Not supported. Use a set of IP permissions to specify the protocol name or number.

ToPort

Not supported. Use a set of IP permissions to specify the port.

SourceSecurityGroupName

Not supported. Use a set of IP permissions to specify a destination security group.

SourceSecurityGroupOwnerId

Not supported. Use a set of IP permissions to specify a destination security group.

Authorize Security Group Ingress

Description

Authorize Security Group Ingress

Usage

ec2_authorize_security_group_ingress(
  CidrIp = NULL,
  FromPort = NULL,
  GroupId = NULL,
  GroupName = NULL,
  IpPermissions = NULL,
  IpProtocol = NULL,
  SourceSecurityGroupName = NULL,
  SourceSecurityGroupOwnerId = NULL,
  ToPort = NULL,
  DryRun = 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

Value

A list object or a character vector

CidrIp

The IPv4 address range, in CIDR format. You can\'t specify this parameter when specifying a source security group. To specify an IPv6 address range, use a set of IP permissions.

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

FromPort

The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all types. If you specify all ICMP types, you must specify all codes.

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

GroupId

The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.

GroupName

[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.

IpPermissions

The sets of IP permissions.

IpProtocol

The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). To specify icmpv6, use a set of IP permissions.

[VPC only] Use -1 to specify all protocols. If you specify -1 or a protocol other than tcp, udp, or icmp, traffic on all ports is allowed, regardless of any ports you specify.

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

SourceSecurityGroupName

[EC2-Classic, default VPC] The name of the source security group. You can\'t specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For EC2-VPC, the source security group must be in the same VPC.

SourceSecurityGroupOwnerId

[nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account. You can\'t specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead.

ToPort

The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all codes. If you specify all ICMP types, you must specify all codes.

Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.

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.

Bundle Instance

Description

Bundle Instance

Usage

ec2_bundle_instance(
  InstanceId,
  Storage,
  DryRun = 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

Value

A list object or a character vector

InstanceId

The ID of the instance to bundle.

Type: String

Default: None

Required: Yes

Storage

The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error.

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.

Cancel Bundle Task

Description

Cancels a bundling operation for an instance store-backed Windows instance.

Usage

ec2_cancel_bundle_task(
  BundleId,
  DryRun = 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

Value

A list object or a character vector

BundleId

The ID of the bundle task.

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.

Cancel Capacity Reservation

Description

Cancel Capacity Reservation

Usage

ec2_cancel_capacity_reservation(
  CapacityReservationId,
  DryRun = 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

Value

A list object or a character vector

CapacityReservationId

The ID of the Capacity Reservation to be cancelled.

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.

Cancel Conversion Task

Description

Cancel Conversion Task

Usage

ec2_cancel_conversion_task(
  ConversionTaskId,
  DryRun = NULL,
  ReasonMessage = 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

Value

A list object or a character vector

ConversionTaskId

The ID of the conversion task.

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.

ReasonMessage

The reason for canceling the conversion task.

Cancel Export Task

Description

Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.

Usage

ec2_cancel_export_task(
  ExportTaskId,
  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

Value

A list object or a character vector

ExportTaskId

The ID of the export task. This is the ID returned by CreateInstanceExportTask.

Cancel Import Task

Description

Cancels an in-process import virtual machine or import snapshot task.

Usage

ec2_cancel_import_task(
  CancelReason = NULL,
  DryRun = NULL,
  ImportTaskId = 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

Value

A list object or a character vector

CancelReason

The reason for canceling the task.

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.

ImportTaskId

The ID of the import image or import snapshot task to be canceled.

Cancel Reserved Instances Listing

Description

Cancel Reserved Instances Listing

Usage

ec2_cancel_reserved_instances_listing(
  ReservedInstancesListingId,
  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

Value

A list object or a character vector

ReservedInstancesListingId

The ID of the Reserved Instance listing.

Cancel Spot Fleet Requests

Description

Cancel Spot Fleet Requests

Usage

ec2_cancel_spot_fleet_requests(
  SpotFleetRequestId,
  TerminateInstances,
  DryRun = 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

Value

A list object or a character vector

SpotFleetRequestId

The IDs of the Spot Fleet requests.

TerminateInstances

Indicates whether to terminate instances for a Spot Fleet request if it is canceled successfully.

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.

Cancel Spot Instance Requests

Description

Cancel Spot Instance Requests

Usage

ec2_cancel_spot_instance_requests(
  SpotInstanceRequestId,
  DryRun = 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

Value

A list object or a character vector

SpotInstanceRequestId

One or more Spot Instance request IDs.

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.

Confirm Product Instance

Description

Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner must verify whether another user\'s instance is eligible for support.

Usage

ec2_confirm_product_instance(
  InstanceId,
  ProductCode,
  DryRun = 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

Value

A list object or a character vector

InstanceId

The ID of the instance.

ProductCode

The product code. This must be a product code that you own.

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.

Copy Fpga Image

Description

Copies the specified Amazon FPGA Image (AFI) to the current Region.

Usage

ec2_copy_fpga_image(
  SourceFpgaImageId,
  SourceRegion,
  DryRun = NULL,
  Description = NULL,
  Name = NULL,
  ClientToken = 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

Value

A list object or a character vector

SourceFpgaImageId

The ID of the source AFI.

SourceRegion

The Region that contains the source AFI.

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.

Description

The description for the new AFI.

Name

The name for the new AFI. The default is the name of the source AFI.

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Copy Image

Description

Copy Image

Usage

ec2_copy_image(
  Name,
  SourceImageId,
  SourceRegion,
  ClientToken = NULL,
  Description = NULL,
  Encrypted = NULL,
  KmsKeyId = NULL,
  DestinationOutpostArn = NULL,
  DryRun = 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

Value

A list object or a character vector

Name

The name of the new AMI in the destination Region.

SourceImageId

The ID of the AMI to copy.

SourceRegion

The name of the Region that contains the AMI to copy.

ClientToken

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

Description

A description for the new AMI in the destination Region.

Encrypted

Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

KmsKeyId

The identifier of the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating encrypted volumes. If this parameter is not specified, your AWS managed CMK for EBS is used. If you specify a CMK, you must also set the encrypted state to true.

You can specify a CMK using any of the following:

• Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

• Key alias. For example, alias/ExampleAlias.

• Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

• Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an identifier that is not valid, the action can appear to complete, but eventually fails.

The specified CMK must exist in the destination Region.

Amazon EBS does not support asymmetric CMKs.

DestinationOutpostArn

The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only specify this parameter when copying an AMI from an AWS Region to an Outpost. The AMI must be in the Region of the destination Outpost. You cannot copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost.

For more information, see Copying AMIs from an AWS Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.

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.

Copy Snapshot

Description

Copy Snapshot

Usage

ec2_copy_snapshot(
  SourceRegion,
  SourceSnapshotId,
  Description = NULL,
  DestinationOutpostArn = NULL,
  DestinationRegion = NULL,
  Encrypted = NULL,
  KmsKeyId = NULL,
  PresignedUrl = NULL,
  TagSpecification = NULL,
  DryRun = 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

Value

A list object or a character vector

SourceRegion

The ID of the Region that contains the snapshot to be copied.

SourceSnapshotId

The ID of the EBS snapshot to copy.

Description

A description for the EBS snapshot.

DestinationOutpostArn

The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only specify this parameter when copying a snapshot from an AWS Region to an Outpost. The snapshot must be in the Region for the destination Outpost. You cannot copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.

For more information, see Copying snapshots from an AWS Region to an Outpost in the Amazon Elastic Compute Cloud User Guide.

DestinationRegion

The destination Region to use in the PresignedUrl parameter of a snapshot copy operation. This parameter is only valid for specifying the destination Region in a PresignedUrl parameter, where it is required.

The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example, ⁠ec2.us-east-1.amazonaws.com⁠). With the AWS CLI, this is specified using the --region parameter or the default Region in your AWS configuration file.

Encrypted

To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Otherwise, omit this parameter. Encrypted snapshots are encrypted, even if you omit this parameter and encryption by default is not enabled. You cannot set this parameter to false. For more information, see Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.

KmsKeyId

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId is specified, the encrypted state must be true.

You can specify the CMK using any of the following:

• Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

• Key alias. For example, alias/ExampleAlias.

• Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

• Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

PresignedUrl

When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query requests.

The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests: Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.

TagSpecification

The tags to apply to the new snapshot.

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.

Create Capacity Reservation

Description

Create Capacity Reservation

Usage

ec2_create_capacity_reservation(
  InstanceType,
  InstancePlatform,
  InstanceCount,
  ClientToken = NULL,
  AvailabilityZone = NULL,
  AvailabilityZoneId = NULL,
  Tenancy = NULL,
  EbsOptimized = NULL,
  EphemeralStorage = NULL,
  EndDate = NULL,
  EndDateType = NULL,
  InstanceMatchCriteria = NULL,
  TagSpecifications = NULL,
  DryRun = 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

Value

A list object or a character vector

InstanceType

The instance type for which to reserve capacity. For more information, see Instance types in the Amazon EC2 User Guide.

InstancePlatform

The type of operating system for which to reserve capacity.

InstanceCount

The number of instances for which to reserve capacity.

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.

AvailabilityZone

The Availability Zone in which to create the Capacity Reservation.

AvailabilityZoneId

The ID of the Availability Zone in which to create the Capacity Reservation.

Tenancy

Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:

• default - The Capacity Reservation is created on hardware that is shared with other AWS accounts.

• dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.

EbsOptimized

Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn\'t available with all instance types. Additional usage charges apply when using an EBS- optimized instance.

EphemeralStorage

Indicates whether the Capacity Reservation supports instances with temporary, block-level storage.

EndDate

The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation\'s state changes to expired when it reaches its end date and time.

You must provide an EndDate value if EndDateType is limited. Omit EndDate if EndDateType is unlimited.

If the EndDateType is limited, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.

EndDateType

Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:

• unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate if the EndDateType is unlimited.

• limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if the EndDateType value is limited.

InstanceMatchCriteria

Indicates the type of instance launches that the Capacity Reservation accepts. The options include:

• open - The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters.

• targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.

Default: open

TagSpecifications

The tags to apply to the Capacity Reservation during launch.

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.

Create Carrier Gateway

Description

Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the AWS Wavelength Developer Guide.

Usage

ec2_create_carrier_gateway(
  VpcId,
  TagSpecification = NULL,
  DryRun = NULL,
  ClientToken = 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

Value

A list object or a character vector

VpcId

The ID of the VPC to associate with the carrier gateway.

TagSpecification

The tags to associate with the carrier gateway.

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.

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Create Client Vpn Endpoint

Description

Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated.

Usage

ec2_create_client_vpn_endpoint(
  ClientCidrBlock,
  ServerCertificateArn,
  Authentication,
  ConnectionLogOptions,
  DnsServers = NULL,
  TransportProtocol = NULL,
  VpnPort = NULL,
  Description = NULL,
  SplitTunnel = NULL,
  DryRun = NULL,
  ClientToken = NULL,
  TagSpecification = NULL,
  SecurityGroupId = NULL,
  VpcId = NULL,
  SelfServicePortal = NULL,
  ClientConnectOptions = 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

Value

A list object or a character vector

ClientCidrBlock

The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. The CIDR block should be /22 or greater.

ServerCertificateArn

The ARN of the server certificate. For more information, see the AWS Certificate Manager User Guide.

Authentication

Information about the authentication method to be used to authenticate clients.

ConnectionLogOptions

Information about the client connection logging options.

If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged:

• Client connection requests

• Client connection results (successful and unsuccessful)

• Reasons for unsuccessful client connection requests

• Client connection termination time

DnsServers

Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server.

TransportProtocol

The transport protocol to be used by the VPN session.

Default value: udp

VpnPort

The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

Valid Values: 443 \| 1194

Default Value: 443

Description

A brief description of the Client VPN endpoint.

SplitTunnel

Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.

By default, split-tunnel on a VPN endpoint is disabled.

For information about split-tunnel VPN endpoints, see Split-Tunnel AWS Client VPN Endpoint in the AWS Client VPN Administrator Guide.

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.

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

TagSpecification

The tags to apply to the Client VPN endpoint during creation.

SecurityGroupId

The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups.

VpcId

The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied.

SelfServicePortal

Specify whether to enable the self-service portal for the Client VPN endpoint.

Default Value: enabled

ClientConnectOptions

The options for managing connection authorization for new client connections.

Create Client Vpn Route

Description

Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for tra_c to speci_c resources or networks.

Usage

ec2_create_client_vpn_route(
  ClientVpnEndpointId,
  DestinationCidrBlock,
  TargetVpcSubnetId,
  Description = NULL,
  ClientToken = NULL,
  DryRun = 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

Value

A list object or a character vector

ClientVpnEndpointId

The ID of the Client VPN endpoint to which to add the route.

DestinationCidrBlock

The IPv4 address range, in CIDR notation, of the route destination. For example:

• To add a route for Internet access, enter ⁠0.0.0.0/0⁠

• To add a route for a peered VPC, enter the peered VPC\'s IPv4 CIDR range

• To add a route for an on-premises network, enter the AWS Site-to-Site VPN connection\'s IPv4 CIDR range

• To add a route for the local network, enter the client CIDR range

TargetVpcSubnetId

The ID of the subnet through which you want to route traffic. The specified subnet must be an existing target network of the Client VPN endpoint.

Alternatively, if you\'re adding a route for the local network, specify local.

Description

A brief description of the route.

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

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.

Create Customer Gateway

Description

Create Customer Gateway

Usage

ec2_create_customer_gateway(
  BgpAsn,
  Type,
  IpAddress = NULL,
  CertificateArn = NULL,
  TagSpecification = NULL,
  DeviceName = NULL,
  DryRun = 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

Value

A list object or a character vector

BgpAsn

For devices that support BGP, the customer gateway\'s BGP ASN.

Default: 65000

Type

The type of VPN connection that this customer gateway supports (ipsec.1).

IpAddress

The Internet-routable IP address for the customer gateway\'s outside interface. The address must be static.

CertificateArn

The Amazon Resource Name (ARN) for the customer gateway certificate.

TagSpecification

The tags to apply to the customer gateway.

DeviceName

A name for the customer gateway device.

Length Constraints: Up to 255 characters.

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.

Create Default Subnet

Description

Creates a default subnet with a size ⁠/20⁠ IPv4 CIDR block in the specified Availability Zone in your default VPC. You can have only one default subnet per Availability Zone. For more information, see Creating a Default Subnet in the Amazon Virtual Private Cloud User Guide.

Usage

ec2_create_default_subnet(
  AvailabilityZone,
  DryRun = 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

Value

A list object or a character vector

AvailabilityZone

The Availability Zone in which to create the default subnet.

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.

Create Default Vpc

Description

Create Default Vpc

Usage

ec2_create_default_vpc(
  DryRun = 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

Value

A list object or a character vector

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.

Create Dhcp Options

Description

Create Dhcp Options

Usage

ec2_create_dhcp_options(
  DhcpConfiguration,
  TagSpecification = NULL,
  DryRun = 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

Value

A list object or a character vector

DhcpConfiguration

A DHCP configuration option.

TagSpecification

The tags to assign to the DHCP option.

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.

Create Egress Only Internet Gateway

Description

[IPv6 only] Creates an egress-only internet gateway for your VPC. An egress-only internet gateway is used to enable outbound communication over IPv6 from instances in your VPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6 connection with your instance.

Usage

ec2_create_egress_only_internet_gateway(
  VpcId,
  ClientToken = NULL,
  DryRun = NULL,
  TagSpecification = 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

Value

A list object or a character vector

VpcId

The ID of the VPC for which to create the egress-only internet gateway.

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

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.

TagSpecification

The tags to assign to the egress-only internet gateway.

Create Fleet

Description

Create Fleet

Usage

ec2_create_fleet(
  LaunchTemplateConfigs,
  TargetCapacitySpecification,
  DryRun = NULL,
  ClientToken = NULL,
  SpotOptions = NULL,
  OnDemandOptions = NULL,
  ExcessCapacityTerminationPolicy = NULL,
  TerminateInstancesWithExpiration = NULL,
  Type = NULL,
  ValidFrom = NULL,
  ValidUntil = NULL,
  ReplaceUnhealthyInstances = NULL,
  TagSpecification = 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

Value

A list object or a character vector

LaunchTemplateConfigs

The configuration for the EC2 Fleet.

TargetCapacitySpecification

The number of units to request.

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.

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

SpotOptions

Describes the configuration of Spot Instances in an EC2 Fleet.

OnDemandOptions

Describes the configuration of On-Demand Instances in an EC2 Fleet.

ExcessCapacityTerminationPolicy

Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.

TerminateInstancesWithExpiration

Indicates whether running instances should be terminated when the EC2 Fleet expires.

Type

The type of request. The default value is maintain.

• maintain - The EC2 Fleet places an asynchronous request for your desired capacity, and continues to maintain your desired Spot capacity by replenishing interrupted Spot Instances.

• request - The EC2 Fleet places an asynchronous one-time request for your desired capacity, but does submit Spot requests in alternative capacity pools if Spot capacity is unavailable, and does not maintain Spot capacity if Spot Instances are interrupted.

• instant - The EC2 Fleet places a synchronous one-time request for your desired capacity, and returns errors for any instances that could not be launched.

For more information, see EC2 Fleet request types in the Amazon EC2 User Guide.

ValidFrom

The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.

ValidUntil

The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new EC2 Fleet requests are placed or able to fulfill the request. If no value is specified, the request remains until you cancel it.

ReplaceUnhealthyInstances

Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type maintain. For more information, see EC2 Fleet health checks in the Amazon EC2 User Guide.

TagSpecification

The key-value pair for tagging the EC2 Fleet request on creation. The value for ResourceType must be fleet, otherwise the fleet request fails. To tag instances at launch, specify the tags in the launch template. For information about tagging after launch, see Tagging your resources.

Create Flow Logs

Description

Create Flow Logs

Usage

ec2_create_flow_logs(
  ResourceId,
  ResourceType,
  TrafficType,
  DryRun = NULL,
  ClientToken = NULL,
  DeliverLogsPermissionArn = NULL,
  LogGroupName = NULL,
  LogDestinationType = NULL,
  LogDestination = NULL,
  LogFormat = NULL,
  TagSpecification = NULL,
  MaxAggregationInterval = 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

Value

A list object or a character vector

ResourceId

The ID of the subnet, network interface, or VPC for which you want to create a flow log.

Constraints: Maximum of 1000 resources

ResourceType

The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.

TrafficType

The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.

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.

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

DeliverLogsPermissionArn

The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

LogGroupName

The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

LogDestinationType

Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.

If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.

Default: cloud-watch-logs

LogDestination

Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType.

If LogDestinationType is not specified or cloud-watch-logs, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group. For example, to publish to a log group called my-logs, specify arn:aws:logs:us-east-1:123456789012:log-group:my-logs. Alternatively, use LogGroupName instead.

If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: ⁠bucket_ARN/subfolder_name/⁠. For example, to specify a subfolder named my-logs in a bucket named my-bucket, use the following ARN: ⁠arn:aws:s3:::my-bucket/my-logs/⁠. You cannot use AWSLogs as a subfolder name. This is a reserved term.

LogFormat

The fields to include in the flow log record, in the order in which they should appear. For a list of available fields, see Flow Log Records. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must specify at least one field.

Specify the fields using the ⁠${field-id}⁠ format, separated by spaces. For the AWS CLI, use single quotation marks (\' \') to surround the parameter value.

TagSpecification

The tags to apply to the flow logs.

MaxAggregationInterval

The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes).

When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds or less, regardless of the value that you specify.

Default: 600

Create Fpga Image

Description

Create Fpga Image

Usage

ec2_create_fpga_image(
  InputStorageLocation,
  DryRun = NULL,
  LogsStorageLocation = NULL,
  Description = NULL,
  Name = NULL,
  ClientToken = NULL,
  TagSpecification = 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

Value

A list object or a character vector

InputStorageLocation

The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.

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.

LogsStorageLocation

The location in Amazon S3 for the output logs.

Description

A description for the AFI.

Name

A name for the AFI.

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

TagSpecification

The tags to apply to the FPGA image during creation.

Create Image

Description

Create Image

Usage

ec2_create_image(
  InstanceId,
  Name,
  BlockDeviceMapping = NULL,
  Description = NULL,
  DryRun = NULL,
  NoReboot = NULL,
  TagSpecification = 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

Value

A list object or a character vector

InstanceId

The ID of the instance.

Name

A name for the new image.

Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes (\'), at-signs (@), or underscores(_)

BlockDeviceMapping

The block device mappings. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action.

Description

A description for the new image.

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.

NoReboot

By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the ⁠No Reboot⁠ option is set, Amazon EC2 doesn\'t shut down the instance before creating the image. When this option is used, file system integrity on the created image can\'t be guaranteed.

TagSpecification

The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the snapshots, or both.

• To tag the AMI, the value for ResourceType must be image.

• To tag the snapshots that are created of the root volume and of other EBS volumes that are attached to the instance, the value for ResourceType must be snapshot. The same tag is applied to all of the snapshots that are created.

If you specify other values for ResourceType, the request fails.

To tag an AMI or snapshot after it has been created, see CreateTags.

Create Instance Export Task

Description

Create Instance Export Task

Usage

ec2_create_instance_export_task(
  ExportToS3,
  InstanceId,
  TargetEnvironment,
  Description = NULL,
  TagSpecification = 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

Value

A list object or a character vector

ExportToS3

The format and location for an export instance task.

InstanceId

The ID of the instance.

TargetEnvironment

The target virtualization environment.

Description

A description for the conversion task or the resource being exported. The maximum length is 255 characters.

TagSpecification

The tags to apply to the export instance task during creation.

Create Internet Gateway

Description

Create Internet Gateway

Usage

ec2_create_internet_gateway(
  TagSpecification = NULL,
  DryRun = 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

Value

A list object or a character vector

TagSpecification

The tags to assign to the internet gateway.

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.

Create Key Pair

Description

Create Key Pair

Usage

ec2_create_key_pair(
  KeyName,
  DryRun = NULL,
  TagSpecification = 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

Value

A list object or a character vector

KeyName

A unique name for the key pair.

Constraints: Up to 255 ASCII characters

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.

TagSpecification

The tags to apply to the new key pair.

Create Launch Template

Description

Creates a launch template. A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify a launch template instead of providing the launch parameters in the request. For more information, see Launching an instance from a launch templatein the Amazon Elastic Compute Cloud User Guide.

Usage

ec2_create_launch_template(
  LaunchTemplateName,
  LaunchTemplateData,
  DryRun = NULL,
  ClientToken = NULL,
  VersionDescription = NULL,
  TagSpecification = 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

Value

A list object or a character vector

LaunchTemplateName

A name for the launch template.

LaunchTemplateData

The information for the launch template.

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.

ClientToken

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraint: Maximum 128 ASCII characters.

VersionDescription

A description for the first version of the launch template.

TagSpecification

The tags to apply to the launch template during creation.

Create Launch Template Version

Description

Create Launch Template Version

Usage

ec2_create_launch_template_version(
  LaunchTemplateData,
  DryRun = NULL,
  ClientToken = NULL,
  LaunchTemplateId = NULL,
  LaunchTemplateName = NULL,
  SourceVersion = NULL,
  VersionDescription = 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

Value

A list object or a character vector

LaunchTemplateData

The information for the launch template.

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.

ClientToken

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraint: Maximum 128 ASCII characters.

LaunchTemplateId

The ID of the launch template. You must specify either the launch template ID or launch template name in the request.

LaunchTemplateName

The name of the launch template. You must specify either the launch template ID or launch template name in the request.

SourceVersion

The version number of the launch template version on which to base the new version. The new version inherits the same launch parameters as the source version, except for parameters that you specify in LaunchTemplateData. Snapshots applied to the block device mapping are ignored when creating a new version unless they are explicitly included.

VersionDescription

A description for the version of the launch template.

Create Local Gateway Route

Description

Creates a static route for the specified local gateway route table.

Usage

ec2_create_local_gateway_route(
  DestinationCidrBlock,
  LocalGatewayRouteTableId,
  LocalGatewayVirtualInterfaceGroupId,
  DryRun = 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

Value

A list object or a character vector

DestinationCidrBlock

The CIDR range used for destination matches. Routing decisions are based on the most specific match.

LocalGatewayRouteTableId

The ID of the local gateway route table.

LocalGatewayVirtualInterfaceGroupId

The ID of the virtual interface group.

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.

Create Local Gateway Route Table Vpc Association

Description

Associates the specified VPC with the specified local gateway route table.

Usage

ec2_create_local_gateway_route_table_vpc_association(
  LocalGatewayRouteTableId,
  VpcId,
  TagSpecification = NULL,
  DryRun = 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

Value

A list object or a character vector

LocalGatewayRouteTableId

The ID of the local gateway route table.

VpcId

The ID of the VPC.

TagSpecification

The tags to assign to the local gateway route table VPC association.

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.

Create Managed Prefix List

Description

Create Managed Prefix List

Usage

ec2_create_managed_prefix_list(
  PrefixListName,
  MaxEntries,
  AddressFamily,
  DryRun = NULL,
  Entry = NULL,
  TagSpecification = NULL,
  ClientToken = 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

Value

A list object or a character vector

PrefixListName

A name for the prefix list.

Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws.

MaxEntries

The maximum number of entries for the prefix list.

AddressFamily

The IP address type.

Valid Values: IPv4 \| IPv6

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.

Entry

One or more entries for the prefix list.

TagSpecification

The tags to apply to the prefix list during creation.

ClientToken

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraints: Up to 255 UTF-8 characters in length.

Create Nat Gateway

Description

Creates a NAT gateway in the specified public subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. Internet-bound traffic from a private subnet can be routed to the NAT gateway, therefore enabling instances in the private subnet to connect to the internet. For more information, see NAT Gateways in the Amazon Virtual Private Cloud User Guide.

Usage

ec2_create_nat_gateway(
  SubnetId,
  AllocationId,
  ClientToken = NULL,
  DryRun = NULL,
  TagSpecification = 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

Value

A list object or a character vector

SubnetId

The subnet in which to create the NAT gateway.

AllocationId

The allocation ID of an Elastic IP address to associate with the NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Constraint: Maximum 64 ASCII characters.

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.

TagSpecification

The tags to assign to the NAT gateway.

Create Network Acl

Description

Create Network Acl

Usage

ec2_create_network_acl(
  VpcId,
  DryRun = NULL,
  TagSpecification = 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

Value

A list object or a character vector

VpcId

The ID of the VPC.

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.

TagSpecification

The tags to assign to the network ACL.

Create Network Acl Entry

Description

Create Network Acl Entry

Usage

ec2_create_network_acl_entry(
  Egress,
  NetworkAclId,
  Protocol,
  RuleAction,
  RuleNumber,
  CidrBlock = NULL,
  DryRun = NULL,
  Icmp = NULL,
  Ipv6CidrBlock = NULL,
  PortRange = 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

Value

A list object or a character vector

Egress

Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).

NetworkAclId

The ID of the network ACL.

Protocol

The protocol number. A value of \'-1\' means all protocols. If you specify \'-1\' or a protocol number other than \'6\' (TCP), \'17\' (UDP), or \'1\' (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol \'58\' (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol \'58\' (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.

RuleAction

Indicates whether to allow or deny the traffic that matches the rule.

RuleNumber

The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number.

Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use.

CidrBlock

The IPv4 network range to allow or deny, in CIDR notation (for example ⁠172.16.0.0/24⁠). We modify the specified CIDR block to its canonical form; for example, if you specify ⁠100.68.0.18/18⁠, we modify it to ⁠100.68.0.0/18⁠.

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.

Icmp

ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.

Ipv6CidrBlock

The IPv6 network range to allow or deny, in CIDR notation (for example ⁠2001:db8:1234:1a00::/64⁠).

PortRange

TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).

Create Network Insights Path

Description

Create Network Insights Path

Usage

ec2_create_network_insights_path(
  Source,
  Destination,
  Protocol,
  ClientToken,
  SourceIp = NULL,
  DestinationIp = NULL,
  DestinationPort = NULL,
  TagSpecification = NULL,
  DryRun = 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

Value

A list object or a character vector

Source

The AWS resource that is the source of the path.

Destination

The AWS resource that is the destination of the path.

Protocol

The protocol.

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

SourceIp

The IP address of the AWS resource that is the source of the path.

DestinationIp

The IP address of the AWS resource that is the destination of the path.

DestinationPort

The destination port.

TagSpecification

The tags to add to the path.

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.

Create Network Interface

Description

Create Network Interface

Usage

ec2_create_network_interface(
  SubnetId,
  Description = NULL,
  DryRun = NULL,
  SecurityGroupId = NULL,
  Ipv6AddressCount = NULL,
  Ipv6Addresses = NULL,
  PrivateIpAddress = NULL,
  PrivateIpAddresses = NULL,
  SecondaryPrivateIpAddressCount = NULL,
  InterfaceType = NULL,
  TagSpecification = 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

Value

A list object or a character vector

SubnetId

The ID of the subnet to associate with the network interface.

Description

A description for the network interface.

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.

SecurityGroupId

The IDs of one or more security groups.

Ipv6AddressCount

The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can\'t use this option if specifying specific IPv6 addresses. If your subnet has the AssignIpv6AddressOnCreation attribute set to true, you can specify 0 to override this setting.

Ipv6Addresses

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can\'t use this option if you\'re specifying a number of IPv6 addresses.

PrivateIpAddress

The primary private IPv4 address of the network interface. If you don\'t specify an IPv4 address, Amazon EC2 selects one for you from the subnet\'s IPv4 CIDR range. If you specify an IP address, you cannot indicate any IP addresses specified in privateIpAddresses as primary (only one IP address can be designated as primary).

PrivateIpAddresses

One or more private IPv4 addresses.

SecondaryPrivateIpAddressCount

The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet\'s IPv4 CIDR range. You can\'t specify this option and specify more than one private IP address using privateIpAddresses.

The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide.

InterfaceType

Indicates the type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.

TagSpecification

The tags to apply to the new network interface.

Create Network Interface Permission

Description

Create Network Interface Permission

Usage

ec2_create_network_interface_permission(
  NetworkInterfaceId,
  Permission,
  AwsAccountId = NULL,
  AwsService = NULL,
  DryRun = 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

Value

A list object or a character vector

NetworkInterfaceId

The ID of the network interface.

Permission

The type of permission to grant.

AwsAccountId

The AWS account ID.

AwsService

The AWS service. Currently not supported.

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.

Create Placement Group

Description

Create Placement Group

Usage

ec2_create_placement_group(
  DryRun = NULL,
  GroupName = NULL,
  Strategy = NULL,
  PartitionCount = NULL,
  TagSpecification = 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

Value

A list object or a character vector

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.

GroupName

A name for the placement group. Must be unique within the scope of your account for the Region.

Constraints: Up to 255 ASCII characters

Strategy

The placement strategy.

PartitionCount

The number of partitions. Valid only when Strategy is set to partition.

TagSpecification

The tags to apply to the new placement group.

Create Reserved Instances Listing

Description

Create Reserved Instances Listing

Usage

ec2_create_reserved_instances_listing(
  ClientToken,
  InstanceCount,
  PriceSchedules,
  ReservedInstancesId,
  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

Value

A list object or a character vector

ClientToken

Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.

InstanceCount

The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call.

PriceSchedules

A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term.

ReservedInstancesId

The ID of the active Standard Reserved Instance.

Create Route

Description

Create Route

Usage

ec2_create_route(
  RouteTableId,
  DestinationCidrBlock = NULL,
  DestinationIpv6CidrBlock = NULL,
  DestinationPrefixListId = NULL,
  DryRun = NULL,
  VpcEndpointId = NULL,
  EgressOnlyInternetGatewayId = NULL,
  GatewayId = NULL,
  InstanceId = NULL,
  NatGatewayId = NULL,
  TransitGatewayId = NULL,
  LocalGatewayId = NULL,
  CarrierGatewayId = NULL,
  NetworkInterfaceId = NULL,
  VpcPeeringConnectionId = 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

Value

A list object or a character vector

RouteTableId

The ID of the route table for the route.

DestinationCidrBlock

The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify ⁠100.68.0.18/18⁠, we modify it to ⁠100.68.0.0/18⁠.

DestinationIpv6CidrBlock

The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.

DestinationPrefixListId

The ID of a prefix list used for the destination match.

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.

VpcEndpointId

The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.

EgressOnlyInternetGatewayId

[IPv6 traffic only] The ID of an egress-only internet gateway.

GatewayId

The ID of an internet gateway or virtual private gateway attached to your VPC.

InstanceId

The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached.

NatGatewayId

[IPv4 traffic only] The ID of a NAT gateway.

TransitGatewayId

The ID of a transit gateway.

LocalGatewayId

The ID of the local gateway.

CarrierGatewayId

The ID of the carrier gateway.

You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone.

NetworkInterfaceId

The ID of a network interface.

VpcPeeringConnectionId

The ID of a VPC peering connection.

Create Route Table

Description

Create Route Table

Usage

ec2_create_route_table(
  VpcId,
  DryRun = NULL,
  TagSpecification = 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

Value

A list object or a character vector

VpcId

The ID of the VPC.

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.

TagSpecification

The tags to assign to the route table.

Create Security Group

Description

Create Security Group

Usage

ec2_create_security_group(
  GroupDescription,
  GroupName,
  VpcId = NULL,
  TagSpecification = NULL,
  DryRun = 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

Value

A list object or a character vector

GroupDescription

A description for the security group. This is informational only.

Constraints: Up to 255 characters in length

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()\#,@[]+=&;!\$\*

GroupName

The name of the security group.

Constraints: Up to 255 characters in length. Cannot start with ⁠sg-⁠.

Constraints for EC2-Classic: ASCII characters

Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()\#,@[]+=&;!\$\*

VpcId

[EC2-VPC] The ID of the VPC. Required for EC2-VPC.

TagSpecification

The tags to assign to the security group.

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.

Create Snapshot

Description

Create Snapshot

Usage

ec2_create_snapshot(
  VolumeId,
  Description = NULL,
  OutpostArn = NULL,
  TagSpecification = NULL,
  DryRun = 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

Value

A list object or a character vector

VolumeId

The ID of the EBS volume.

Description

A description for the snapshot.

OutpostArn

The Amazon Resource Name (ARN) of the AWS Outpost on which to create a local snapshot.

• To create a snapshot of a volume in a Region, omit this parameter. The snapshot is created in the same Region as the volume.

• To create a snapshot of a volume on an Outpost and store the snapshot in the Region, omit this parameter. The snapshot is created in the Region for the Outpost.

• To create a snapshot of a volume on an Outpost and store the snapshot on an Outpost, specify the ARN of the destination Outpost. The snapshot must be created on the same Outpost as the volume.

For more information, see Creating local snapshots from volumes on an Outpost in the Amazon Elastic Compute Cloud User Guide.

TagSpecification

The tags to apply to the snapshot during creation.

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.

Create Snapshots

Description

Create Snapshots

Usage

ec2_create_snapshots(
  InstanceSpecification,
  Description = NULL,
  OutpostArn = NULL,
  TagSpecification = NULL,
  DryRun = NULL,
  CopyTagsFromSource = 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

Value

A list object or a character vector

InstanceSpecification

The instance to specify which volumes should be included in the snapshots.

Description

A description propagated to every snapshot specified by the instance.

OutpostArn

The Amazon Resource Name (ARN) of the AWS Outpost on which to create the local snapshots.

• To create snapshots from an instance in a Region, omit this parameter. The snapshots are created in the same Region as the instance.

• To create snapshots from an instance on an Outpost and store the snapshots in the Region, omit this parameter. The snapshots are created in the Region for the Outpost.

• To create snapshots from an instance on an Outpost and store the snapshots on an Outpost, specify the ARN of the destination Outpost. The snapshots must be created on the same Outpost as the instance.

For more information, see Creating multi-volume local snapshots from instances on an Outpost in the Amazon Elastic Compute Cloud User Guide.

TagSpecification

Tags to apply to every snapshot specified by the instance.

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.

CopyTagsFromSource

Copies the tags from the specified volume to corresponding snapshot.

Create Spot Datafeed Subscription

Description

Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per AWS account. For more information, see Spot Instance data feed in the Amazon EC2 User Guide for Linux Instances.

Usage

ec2_create_spot_datafeed_subscription(
  Bucket,
  DryRun = NULL,
  Prefix = 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

Value

A list object or a character vector

Bucket

The name of the Amazon S3 bucket in which to store the Spot Instance data feed. For more information about bucket names, see Rules for bucket naming in the Amazon S3 Developer Guide.

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.

Prefix

The prefix for the data feed file names.

Create Subnet

Description

Create Subnet

Usage

ec2_create_subnet(
  VpcId,
  CidrBlock,
  TagSpecification = NULL,
  AvailabilityZone = NULL,
  AvailabilityZoneId = NULL,
  Ipv6CidrBlock = NULL,
  OutpostArn = NULL,
  DryRun = 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

Value

A list object or a character vector

VpcId

The ID of the VPC.

CidrBlock

The IPv4 network range for the subnet, in CIDR notation. For example, ⁠10.0.0.0/24⁠. We modify the specified CIDR block to its canonical form; for example, if you specify ⁠100.68.0.18/18⁠, we modify it to ⁠100.68.0.0/18⁠.

TagSpecification

The tags to assign to the subnet.

AvailabilityZone

The Availability Zone or Local Zone for the subnet.

Default: AWS selects one for you. If you create more than one subnet in your VPC, we do not necessarily select a different zone for each subnet.

To create a subnet in a Local Zone, set this value to the Local Zone ID, for example ⁠us-west-2-lax-1a⁠. For information about the Regions that support Local Zones, see Available Regions in the Amazon Elastic Compute Cloud User Guide.

To create a subnet in an Outpost, set this value to the Availability Zone for the Outpost and specify the Outpost ARN.

AvailabilityZoneId

The AZ ID or the Local Zone ID of the subnet.

Ipv6CidrBlock

The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length.

OutpostArn

The Amazon Resource Name (ARN) of the Outpost. If you specify an Outpost ARN, you must also specify the Availability Zone of the Outpost subnet.

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.

Create Tags

Description

Create Tags

Usage

ec2_create_tags(
  ResourceId,
  Tag,
  DryRun = 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

Value

A list object or a character vector

ResourceId

The IDs of the resources, separated by spaces.

Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.

Tag

The tags. The value parameter is required, but if you don\'t want the tag to have a value, specify the parameter with no value, and we set the value to an empty string.

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.

Create Traffic Mirror Filter

Description

Create Traffic Mirror Filter

Usage

ec2_create_traffic_mirror_filter(
  Description = NULL,
  TagSpecification = NULL,
  DryRun = NULL,
  ClientToken = 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

Value

A list object or a character vector

Description

The description of the Traffic Mirror filter.

TagSpecification

The tags to assign to a Traffic Mirror filter.

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.

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Create Traffic Mirror Filter Rule

Description

Create Traffic Mirror Filter Rule

Usage

ec2_create_traffic_mirror_filter_rule(
  TrafficMirrorFilterId,
  TrafficDirection,
  RuleNumber,
  RuleAction,
  DestinationCidrBlock,
  SourceCidrBlock,
  DestinationPortRange = NULL,
  SourcePortRange = NULL,
  Protocol = NULL,
  Description = NULL,
  DryRun = NULL,
  ClientToken = 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

Value

A list object or a character vector

TrafficMirrorFilterId

The ID of the filter that this rule is associated with.

TrafficDirection

The type of traffic (ingress \| egress).

RuleNumber

The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number.

RuleAction

The action to take (accept \| reject) on the filtered traffic.

DestinationCidrBlock

The destination CIDR block to assign to the Traffic Mirror rule.

SourceCidrBlock

The source CIDR block to assign to the Traffic Mirror rule.

DestinationPortRange

The destination port range.

SourcePortRange

The source port range.

Protocol

The protocol, for example UDP, to assign to the Traffic Mirror rule.

For information about the protocol value, see Protocol Numbers on the Internet Assigned Numbers Authority (IANA) website.

Description

The description of the Traffic Mirror rule.

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.

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Create Traffic Mirror Session

Description

Create Traffic Mirror Session

Usage

ec2_create_traffic_mirror_session(
  NetworkInterfaceId,
  TrafficMirrorTargetId,
  TrafficMirrorFilterId,
  SessionNumber,
  PacketLength = NULL,
  VirtualNetworkId = NULL,
  Description = NULL,
  TagSpecification = NULL,
  DryRun = NULL,
  ClientToken = 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

Value

A list object or a character vector

NetworkInterfaceId

The ID of the source network interface.

TrafficMirrorTargetId

The ID of the Traffic Mirror target.

TrafficMirrorFilterId

The ID of the Traffic Mirror filter.

SessionNumber

The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets.

Valid values are 1-32766.

PacketLength

The number of bytes in each packet to mirror. These are bytes after the VXLAN header. Do not specify this parameter when you want to mirror the entire packet. To mirror a subset of the packet, set this to the length (in bytes) that you want to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target.

If you do not want to mirror the entire packet, use the PacketLength parameter to specify the number of bytes in each packet to mirror.

VirtualNetworkId

The VXLAN ID for the Traffic Mirror session. For more information about the VXLAN protocol, see RFC 7348. If you do not specify a VirtualNetworkId, an account-wide unique id is chosen at random.

Description

The description of the Traffic Mirror session.

TagSpecification

The tags to assign to a Traffic Mirror session.

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.

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Create Traffic Mirror Target

Description

Create Traffic Mirror Target

Usage

ec2_create_traffic_mirror_target(
  NetworkInterfaceId = NULL,
  NetworkLoadBalancerArn = NULL,
  Description = NULL,
  TagSpecification = NULL,
  DryRun = NULL,
  ClientToken = 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

Value

A list object or a character vector

NetworkInterfaceId

The network interface ID that is associated with the target.

NetworkLoadBalancerArn

The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target.

Description

The description of the Traffic Mirror target.

TagSpecification

The tags to assign to the Traffic Mirror target.

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.

ClientToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Create Transit Gateway

Description

Create Transit Gateway

Usage

ec2_create_transit_gateway(
  Description = NULL,
  Options = NULL,
  TagSpecification = NULL,
  DryRun = 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

Value

A list object or a character vector

Description

A description of the transit gateway.

Options

The transit gateway options.

TagSpecification

The tags to apply to the transit gateway.

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.

Create Transit Gateway Connect

Description

Create Transit Gateway Connect

Usage

ec2_create_transit_gateway_connect(
  TransportTransitGatewayAttachmentId,
  Options,
  TagSpecification = NULL,
  DryRun = 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

Value

A list object or a character vector

TransportTransitGatewayAttachmentId

The ID of the transit gateway attachment. You can specify a VPC attachment or a AWS Direct Connect attachment.

Options

The Connect attachment options.

TagSpecification

The tags to apply to the Connect attachment.

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.

Create Transit Gateway Connect Peer

Description

Create Transit Gateway Connect Peer

Usage

ec2_create_transit_gateway_connect_peer(
  TransitGatewayAttachmentId,
  PeerAddress,
  InsideCidrBlocks,
  TransitGatewayAddress = NULL,
  BgpOptions = NULL,
  TagSpecification = NULL,
  DryRun = 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

Value

A list object or a character vector

TransitGatewayAttachmentId

The ID of the Connect attachment.

PeerAddress

The peer IP address (GRE outer IP address) on the appliance side of the Connect peer.

InsideCidrBlocks

The range of inside IP addresses that are used for BGP peering. You must specify a size /29 IPv4 CIDR block from the ⁠169.254.0.0/16⁠ range. The first address from the range must be configured on the appliance as the BGP IP address. You can also optionally specify a size /125 IPv6 CIDR block from the ⁠fd00::/8⁠ range.

TransitGatewayAddress

The peer IP address (GRE outer IP address) on the transit gateway side of the Connect peer, which must be specified from a transit gateway CIDR block. If not specified, Amazon automatically assigns the first available IP address from the transit gateway CIDR block.

BgpOptions

The BGP options for the Connect peer.

TagSpecification

The tags to apply to the Connect peer.

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.

Create Transit Gateway Multicast Domain

Description

Create Transit Gateway Multicast Domain

Usage

ec2_create_transit_gateway_multicast_domain(
  TransitGatewayId,
  Options = NULL,
  TagSpecification = NULL,
  DryRun = 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

Value

A list object or a character vector