salt.modules.boto_ec2¶

Connection module for Amazon EC2

New in version 2015.8.0.

configuration:: This module accepts explicit EC2 credentials but can also utilize IAM roles assigned to the instance through Instance Profiles. Dynamic credentials are then automatically obtained from AWS API and no further configuration is necessary. More Information available here.

If IAM roles are not used you need to specify them either in a pillar or in the minion's config file:

ec2.keyid: GKTADJGHEIQSXMKKRBJ08H
ec2.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs

A region may also be specified in the configuration:

ec2.region: us-east-1

If a region is not specified, the default is us-east-1.

It's also possible to specify key, keyid, and region via a profile, either as a passed in dict, or as a string to pull from pillars or minion config:

myprofile:
  keyid: GKTADJGHEIQSXMKKRBJ08H
  key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
  region: us-east-1

depends:: boto

salt.modules.boto_ec2.allocate_eip_address(domain=None, region=None, key=None, keyid=None, profile=None)¶

Allocate a new Elastic IP address and associate it with your account.

domain: (string) Optional param - if set to exactly 'vpc', the address will be allocated to the VPC. The default simply maps the EIP to your account container.
returns: (dict) dict of 'interesting' information about the newly allocated EIP, with probably the most interesting keys being 'public_ip'; and 'allocation_id' iff 'domain=vpc' was passed.

CLI Example:

salt-call boto_ec2.allocate_eip_address domain=vpc

New in version 2016.3.0.

salt.modules.boto_ec2.assign_private_ip_addresses(network_interface_name=None, network_interface_id=None, private_ip_addresses=None, secondary_private_ip_address_count=None, allow_reassignment=False, region=None, key=None, keyid=None, profile=None)¶

Assigns one or more secondary private IP addresses to a network interface.

network_interface_id: (string) - ID of the network interface to associate the IP with (exclusive with 'network_interface_name')
network_interface_name: (string) - Name of the network interface to associate the IP with (exclusive with 'network_interface_id')
private_ip_addresses: (list) - Assigns the specified IP addresses as secondary IP addresses to the network interface (exclusive with 'secondary_private_ip_address_count')
secondary_private_ip_address_count: (int) - The number of secondary IP addresses to assign to the network interface. (exclusive with 'private_ip_addresses')
allow_reassociation: (bool) – Allow a currently associated EIP to be re-associated with the new instance or interface.
returns: (bool) - True on success, False on failure.

CLI Example:

salt myminion boto_ec2.assign_private_ip_addresses network_interface_name=my_eni private_ip_addresses=private_ip
salt myminion boto_ec2.assign_private_ip_addresses network_interface_name=my_eni secondary_private_ip_address_count=2

New in version 2017.7.0.

salt.modules.boto_ec2.associate_eip_address(instance_id=None, instance_name=None, public_ip=None, allocation_id=None, network_interface_id=None, network_interface_name=None, private_ip_address=None, allow_reassociation=False, region=None, key=None, keyid=None, profile=None)¶

Associate an Elastic IP address with a currently running instance or a network interface. This requires exactly one of either 'public_ip' or 'allocation_id', depending on whether you’re associating a VPC address or a plain EC2 address.

instance_id: (string) – ID of the instance to associate with (exclusive with 'instance_name')
instance_name: (string) – Name tag of the instance to associate with (exclusive with 'instance_id')
public_ip: (string) – Public IP address, for standard EC2 based allocations.
allocation_id: (string) – Allocation ID for a VPC-based EIP.
network_interface_id: (string) - ID of the network interface to associate the EIP with
network_interface_name: (string) - Name of the network interface to associate the EIP with
private_ip_address: (string) – The primary or secondary private IP address to associate with the Elastic IP address.
allow_reassociation: (bool) – Allow a currently associated EIP to be re-associated with the new instance or interface.
returns: (bool) - True on success, False on failure.

CLI Example:

salt myminion boto_ec2.associate_eip_address instance_name=bubba.ho.tep allocation_id=eipalloc-ef382c8a

New in version 2016.3.0.

salt.modules.boto_ec2.attach_network_interface(device_index, name=None, network_interface_id=None, instance_name=None, instance_id=None, region=None, key=None, keyid=None, profile=None)¶

Attach an Elastic Network Interface.

New in version 2016.3.0.

CLI Example:

salt myminion boto_ec2.attach_network_interface my_eni instance_name=salt-master device_index=0

salt.modules.boto_ec2.attach_volume(volume_id, instance_id, device, region=None, key=None, keyid=None, profile=None)¶

Attach an EBS volume to an EC2 instance. ..

volume_id: (string) – The ID of the EBS volume to be attached.
instance_id: (string) – The ID of the EC2 instance to attach the volume to.
device: (string) – The device on the instance through which the volume is exposed (e.g. /dev/sdh)
returns: (bool) - True on success, False on failure.

CLI Example:

salt-call boto_ec2.attach_volume vol-12345678 i-87654321 /dev/sdh

salt.modules.boto_ec2.create_image(ami_name, instance_id=None, instance_name=None, tags=None, region=None, key=None, keyid=None, profile=None, description=None, no_reboot=False, dry_run=False, filters=None)¶

Given instance properties that define exactly one instance, create AMI and return AMI-id.

CLI Examples:

salt myminion boto_ec2.create_image ami_name instance_name=myinstance
salt myminion boto_ec2.create_image another_ami_name tags='{"mytag": "value"}' description='this is my ami'

salt.modules.boto_ec2.create_key(key_name, save_path, region=None, key=None, keyid=None, profile=None)¶

Creates a key and saves it to a given path. Returns the private key.

CLI Example:

salt myminion boto_ec2.create_key mykey /root/

salt.modules.boto_ec2.create_network_interface(name, subnet_id=None, subnet_name=None, private_ip_address=None, description=None, groups=None, region=None, key=None, keyid=None, profile=None)¶

Create an Elastic Network Interface.

New in version 2016.3.0.

CLI Example:

salt myminion boto_ec2.create_network_interface my_eni subnet-12345 description=my_eni groups=['my_group']

salt.modules.boto_ec2.create_tags(resource_ids, tags, region=None, key=None, keyid=None, profile=None)¶

Create new metadata tags for the specified resource ids.

New in version 2016.11.0.

resource_ids: (string) or (list) – List of resource IDs. A plain string will be converted to a list of one element.
tags: (dict) – Dictionary of name/value pairs. To create only a tag name, pass '' as the value.
returns: (bool) - True on success, False on failure.

CLI Example:

salt-call boto_ec2.create_tags vol-12345678 '{"Name": "myVolume01"}'

salt.modules.boto_ec2.create_volume(zone_name, size=None, snapshot_id=None, volume_type=None, iops=None, encrypted=False, kms_key_id=None, wait_for_creation=False, region=None, key=None, keyid=None, profile=None)¶

Create an EBS volume to an availability zone.

zone_name

(string) – The Availability zone name of the EBS volume to be created.

size

(int) – The size of the new volume, in GiB. If you're creating the: volume from a snapshot and don't specify a volume size, the default is the snapshot size.

snapshot_id

(string) – The snapshot ID from which the new volume will be created.

volume_type

(string) - The type of the volume. Valid volume types for AWS can be found here:: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html

iops

(int) - The provisioned IOPS you want to associate with this volume.

encrypted

(bool) - Specifies whether the volume should be encrypted.

kms_key_id

(string) - If encrypted is True, this KMS Key ID may be specified to: encrypt volume with this key e.g.: arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef

wait_for_creation

(bool) - Whether or not to wait for volume creation to complete.

returns

(string) - created volume id on success, error message on failure.

CLI Example:

salt-call boto_ec2.create_volume us-east-1a size=10
salt-call boto_ec2.create_volume us-east-1a snapshot_id=snap-0123abcd

salt.modules.boto_ec2.delete_key(key_name, region=None, key=None, keyid=None, profile=None)¶

Deletes a key. Always returns True

CLI Example:

salt myminion boto_ec2.delete_key mykey

salt.modules.boto_ec2.delete_network_interface(name=None, network_interface_id=None, region=None, key=None, keyid=None, profile=None)¶

Create an Elastic Network Interface.

New in version 2016.3.0.

CLI Example:

salt myminion boto_ec2.create_network_interface my_eni subnet-12345 description=my_eni groups=['my_group']

salt.modules.boto_ec2.delete_tags(resource_ids, tags, region=None, key=None, keyid=None, profile=None)¶

Delete metadata tags for the specified resource ids.

New in version 2016.11.0.

resource_ids

(string) or (list) – List of resource IDs. A plain string will be converted to a list of one element.

tags

(dict) or (list) – Either a dictionary containing name/value pairs or a list containing just tag names.: If you pass in a dictionary, the values must match the actual tag values or the tag will not be deleted. If you pass in a value of None for the tag value, all tags with that name will be deleted.

returns

(bool) - True on success, False on failure.

CLI Example:

salt-call boto_ec2.delete_tags vol-12345678 '{"Name": "myVolume01"}'
salt-call boto_ec2.delete_tags vol-12345678 '["Name","MountPoint"]'

salt.modules.boto_ec2.delete_volume(volume_id, instance_id=None, device=None, force=False, region=None, key=None, keyid=None, profile=None)¶

Detach an EBS volume from an EC2 instance.

New in version 2016.11.0.

volume_id: (string) – The ID of the EBS volume to be deleted.
force: (bool) – Forces deletion even if the device has not yet been detached from its instance.
returns: (bool) - True on success, False on failure.

CLI Example:

salt-call boto_ec2.delete_volume vol-12345678

salt.modules.boto_ec2.detach_network_interface(name=None, network_interface_id=None, attachment_id=None, force=False, region=None, key=None, keyid=None, profile=None)¶

Detach an Elastic Network Interface.

New in version 2016.3.0.

CLI Example:

salt myminion boto_ec2.detach_network_interface my_eni

salt.modules.boto_ec2.detach_volume(volume_id, instance_id=None, device=None, force=False, wait_for_detachement=False, region=None, key=None, keyid=None, profile=None)¶

Detach an EBS volume from an EC2 instance.

New in version 2016.11.0.

volume_id

(string) – The ID of the EBS volume to be detached.

instance_id

(string) – The ID of the EC2 instance from which it will be detached.

device

(string) – The device on the instance through which the volume is exposted (e.g. /dev/sdh)

force

(bool) – Forces detachment if the previous detachment attempt did not occur cleanly.: This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance will not have an opportunity to flush file system caches nor file system meta data. If you use this option, you must perform file system check and repair procedures.

wait_for_detachement

(bool) - Whether or not to wait for volume detachement to complete.

returns

(bool) - True on success, False on failure.

CLI Example:

salt-call boto_ec2.detach_volume vol-12345678 i-87654321

salt.modules.boto_ec2.disassociate_eip_address(public_ip=None, association_id=None, region=None, key=None, keyid=None, profile=None)¶

Disassociate an Elastic IP address from a currently running instance. This requires exactly one of either 'association_id' or 'public_ip', depending on whether you’re dealing with a VPC or EC2 Classic address.

public_ip: (string) – Public IP address, for EC2 Classic allocations.
association_id: (string) – Association ID for a VPC-bound EIP.
returns: (bool) - True on success, False on failure.

CLI Example:

salt myminion boto_ec2.disassociate_eip_address association_id=eipassoc-e3ba2d16

New in version 2016.3.0.

salt.modules.boto_ec2.exists(instance_id=None, name=None, tags=None, region=None, key=None, keyid=None, profile=None, in_states=None, filters=None)¶

Given an instance id, check to see if the given instance id exists.

Returns True if the given instance with the given id, name, or tags exists; otherwise, False is returned.

CLI Example:

salt myminion boto_ec2.exists myinstance

salt.modules.boto_ec2.find_images(ami_name=None, executable_by=None, owners=None, image_ids=None, tags=None, region=None, key=None, keyid=None, profile=None, return_objs=False)¶

Given image properties, find and return matching AMI ids

CLI Examples:

salt myminion boto_ec2.find_images tags='{"mytag": "value"}'

salt.modules.boto_ec2.find_instances(instance_id=None, name=None, tags=None, region=None, key=None, keyid=None, profile=None, return_objs=False, in_states=None, filters=None)¶

Given instance properties, find and return matching instance ids

CLI Examples:

salt myminion boto_ec2.find_instances # Lists all instances
salt myminion boto_ec2.find_instances name=myinstance
salt myminion boto_ec2.find_instances tags='{"mytag": "value"}'
salt myminion boto_ec2.find_instances filters='{"vpc-id": "vpc-12345678"}'

salt.modules.boto_ec2.get_all_eip_addresses(addresses=None, allocation_ids=None, region=None, key=None, keyid=None, profile=None)¶

Get public addresses of some, or all EIPs associated with the current account.

addresses: (list) - Optional list of addresses. If provided, only the addresses associated with those in the list will be returned.
allocation_ids: (list) - Optional list of allocation IDs. If provided, only the addresses associated with the given allocation IDs will be returned.
returns: (list) - A list of the requested EIP addresses

CLI Example:

salt-call boto_ec2.get_all_eip_addresses

New in version 2016.3.0.

salt.modules.boto_ec2.get_all_tags(filters=None, region=None, key=None, keyid=None, profile=None)¶

Describe all tags matching the filter criteria, or all tags in the account otherwise.

New in version 2018.3.0.

filters: (dict) - Additional constraints on which volumes to return. Note that valid filters vary extensively depending on the resource type. When in doubt, search first without a filter and then use the returned data to help fine-tune your search. You can generally garner the resource type from its ID (e.g. vol-XXXXX is a volume, i-XXXXX is an instance, etc.

CLI Example:

salt-call boto_ec2.get_all_tags '{"tag:Name": myInstanceNameTag, resource-type: instance}'

salt.modules.boto_ec2.get_all_volumes(volume_ids=None, filters=None, return_objs=False, region=None, key=None, keyid=None, profile=None)¶

Get a list of all EBS volumes, optionally filtered by provided 'filters' param

New in version 2016.11.0.

volume_ids: (list) - Optional list of volume_ids. If provided, only the volumes associated with those in the list will be returned.
filters: (dict) - Additional constraints on which volumes to return. Valid filters are:

attachment.attach-time - The time stamp when the attachment initiated.
attachment.delete-on-termination - Whether the volume is deleted on instance termination.
attachment.device - The device name that is exposed to the instance (for example, /dev/sda1).
attachment.instance-id - The ID of the instance the volume is attached to.
attachment.status - The attachment state (attaching | attached | detaching | detached).
availability-zone - The Availability Zone in which the volume was created.
create-time - The time stamp when the volume was created.
encrypted - The encryption status of the volume.
size - The size of the volume, in GiB.
snapshot-id - The snapshot from which the volume was created.
status - The status of the volume (creating | available | in-use | deleting | deleted | error).
tag:key=value - The key/value combination of a tag assigned to the resource.
volume-id - The volume ID.
volume-type - The Amazon EBS volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.

return_objs: (bool) - Changes the return type from list of volume IDs to list of boto.ec2.volume.Volume objects
returns: (list) - A list of the requested values: Either the volume IDs or, if return_objs is True, boto.ec2.volume.Volume objects.

CLI Example:

salt-call boto_ec2.get_all_volumes filters='{"tag:Name": "myVolume01"}'

salt.modules.boto_ec2.get_attribute(attribute, instance_name=None, instance_id=None, region=None, key=None, keyid=None, profile=None, filters=None)¶

Get an EC2 instance attribute.

CLI Example:

salt myminion boto_ec2.get_attribute sourceDestCheck instance_name=my_instance

Available attributes:

instanceType
kernel
ramdisk
userData
disableApiTermination
instanceInitiatedShutdownBehavior
rootDeviceName
blockDeviceMapping
productCodes
sourceDestCheck
groupSet
ebsOptimized
sriovNetSupport

salt.modules.boto_ec2.get_eip_address_info(addresses=None, allocation_ids=None, region=None, key=None, keyid=None, profile=None)¶

Get 'interesting' info about some, or all EIPs associated with the current account.

addresses: (list) - Optional list of addresses. If provided, only the addresses associated with those in the list will be returned.
allocation_ids: (list) - Optional list of allocation IDs. If provided, only the addresses associated with the given allocation IDs will be returned.
returns: (list of dicts) - A list of dicts, each containing the info for one of the requested EIPs.

CLI Example:

salt-call boto_ec2.get_eip_address_info addresses=52.4.2.15

New in version 2016.3.0.

salt.modules.boto_ec2.get_id(name=None, tags=None, region=None, key=None, keyid=None, profile=None, in_states=None, filters=None)¶

Given instance properties, return the instance id if it exists.

CLI Example:

salt myminion boto_ec2.get_id myinstance

salt.modules.boto_ec2.get_key(key_name, region=None, key=None, keyid=None, profile=None)¶

Check to see if a key exists. Returns fingerprint and name if it does and False if it doesn't

CLI Example:

salt myminion boto_ec2.get_key mykey

salt.modules.boto_ec2.get_keys(keynames=None, filters=None, region=None, key=None, keyid=None, profile=None)¶

Gets all keys or filters them by name and returns a list. keynames (list):: A list of the names of keypairs to retrieve. If not provided, all key pairs will be returned. filters (dict) :: Optional filters that can be used to limit the results returned. Filters are provided in the form of a dictionary consisting of filter names as the key and filter values as the value. The set of allowable filter names/values is dependent on the request being performed. Check the EC2 API guide for details.

CLI Example:

salt myminion boto_ec2.get_keys

salt.modules.boto_ec2.get_network_interface(name=None, network_interface_id=None, region=None, key=None, keyid=None, profile=None)¶

Get an Elastic Network Interface.

New in version 2016.3.0.

CLI Example:

salt myminion boto_ec2.get_network_interface name=my_eni

salt.modules.boto_ec2.get_network_interface_id(name, region=None, key=None, keyid=None, profile=None)¶

Get an Elastic Network Interface id from its name tag.

New in version 2016.3.0.

CLI Example:

salt myminion boto_ec2.get_network_interface_id name=my_eni

salt.modules.boto_ec2.get_tags(instance_id=None, keyid=None, key=None, profile=None, region=None)¶

Given an instance_id, return a list of tags associated with that instance.

returns: (list) - list of tags as key/value pairs

CLI Example:

salt myminion boto_ec2.get_tags instance_id

salt.modules.boto_ec2.get_unassociated_eip_address(domain='standard', region=None, key=None, keyid=None, profile=None)¶

Return the first unassociated EIP

domain: Indicates whether the address is an EC2 address or a VPC address (standard|vpc).

CLI Example:

salt-call boto_ec2.get_unassociated_eip_address

New in version 2016.3.0.

salt.modules.boto_ec2.get_zones(region=None, key=None, keyid=None, profile=None)¶

Get a list of AZs for the configured region.

CLI Example:

salt myminion boto_ec2.get_zones

salt.modules.boto_ec2.import_key(key_name, public_key_material, region=None, key=None, keyid=None, profile=None)¶

Imports the public key from an RSA key pair that you created with a third-party tool. Supported formats: - OpenSSH public key format (e.g., the format in ~/.ssh/authorized_keys) - Base64 encoded DER format - SSH public key file format as specified in RFC4716 - DSA keys are not supported. Make sure your key generator is set up to create RSA keys. Supported lengths: 1024, 2048, and 4096.

CLI Example:

salt myminion boto_ec2.import mykey publickey

salt.modules.boto_ec2.modify_network_interface_attribute(name=None, network_interface_id=None, attr=None, value=None, region=None, key=None, keyid=None, profile=None)¶

Modify an attribute of an Elastic Network Interface.

New in version 2016.3.0.

CLI Example:

salt myminion boto_ec2.modify_network_interface_attribute my_eni attr=description value='example description'

salt.modules.boto_ec2.release_eip_address(public_ip=None, allocation_id=None, region=None, key=None, keyid=None, profile=None)¶

Free an Elastic IP address. Pass either a public IP address to release an EC2 Classic EIP, or an AllocationId to release a VPC EIP.

public_ip: (string) - The public IP address - for EC2 elastic IPs.
allocation_id: (string) - The Allocation ID - for VPC elastic IPs.
returns: (bool) - True on success, False on failure

CLI Example:

salt myminion boto_ec2.release_eip_address allocation_id=eipalloc-ef382c8a

New in version 2016.3.0.

salt.modules.boto_ec2.run(image_id, name=None, tags=None, key_name=None, security_groups=None, user_data=None, instance_type='m1.small', placement=None, kernel_id=None, ramdisk_id=None, monitoring_enabled=None, vpc_id=None, vpc_name=None, subnet_id=None, subnet_name=None, private_ip_address=None, block_device_map=None, disable_api_termination=None, instance_initiated_shutdown_behavior=None, placement_group=None, client_token=None, security_group_ids=None, security_group_names=None, additional_info=None, tenancy=None, instance_profile_arn=None, instance_profile_name=None, ebs_optimized=None, network_interface_id=None, network_interface_name=None, region=None, key=None, keyid=None, profile=None, network_interfaces=None)¶

Create and start an EC2 instance.

Returns True if the instance was created; otherwise False.

CLI Example:

salt myminion boto_ec2.run ami-b80c2b87 name=myinstance

image_id

(string) – The ID of the image to run.

name

(string) - The name of the instance.

tags

(dict of key: value pairs) - tags to apply to the instance.

key_name

(string) – The name of the key pair with which to launch instances.

security_groups

(list of strings) – The names of the EC2 classic security groups with which to associate instances

user_data

(string) – The Base64-encoded MIME user data to be made available to the instance(s) in this reservation.

instance_type

(string) – The type of instance to run. Note that some image types (e.g. hvm) only run on some instance types.

placement

(string) – The Availability Zone to launch the instance into.

kernel_id

(string) – The ID of the kernel with which to launch the instances.

ramdisk_id

(string) – The ID of the RAM disk with which to launch the instances.

monitoring_enabled

(bool) – Enable detailed CloudWatch monitoring on the instance.

vpc_id

(string) - ID of a VPC to bind the instance to. Exclusive with vpc_name.

vpc_name

(string) - Name of a VPC to bind the instance to. Exclusive with vpc_id.

subnet_id

(string) – The subnet ID within which to launch the instances for VPC.

subnet_name

(string) – The name of a subnet within which to launch the instances for VPC.

private_ip_address

(string) – If you’re using VPC, you can optionally use this parameter to assign the instance a specific available IP address from the subnet (e.g. 10.0.0.25).

block_device_map

(boto.ec2.blockdevicemapping.BlockDeviceMapping) – A BlockDeviceMapping data structure describing the EBS volumes associated with the Image. (string) - A string representation of a BlockDeviceMapping structure (dict) - A dict describing a BlockDeviceMapping structure

YAML example:

device-maps:
    /dev/sdb:
        ephemeral_name: ephemeral0
    /dev/sdc:
        ephemeral_name: ephemeral1
    /dev/sdd:
        ephemeral_name: ephemeral2
    /dev/sde:
        ephemeral_name: ephemeral3
    /dev/sdf:
        size: 20
        volume_type: gp2

disable_api_termination

(bool) – If True, the instances will be locked and will not be able to be terminated via the API.

instance_initiated_shutdown_behavior

(string) – Specifies whether the instance stops or terminates on instance-initiated shutdown. Valid values are: stop, terminate

placement_group

(string) – If specified, this is the name of the placement group in which the instance(s) will be launched.

client_token

(string) – Unique, case-sensitive identifier you provide to ensure idempotency of the request. Maximum 64 ASCII characters.

security_group_ids

(list of strings) – The ID(s) of the VPC security groups with which to associate instances.

security_group_names

(list of strings) – The name(s) of the VPC security groups with which to associate instances.

additional_info

(string) – Specifies additional information to make available to the instance(s).

tenancy

(string) – The tenancy of the instance you want to launch. An instance with a tenancy of ‘dedicated’ runs on single-tenant hardware and can only be launched into a VPC. Valid values are:”default” or “dedicated”. NOTE: To use dedicated tenancy you MUST specify a VPC subnet-ID as well.

instance_profile_arn

(string) – The Amazon resource name (ARN) of the IAM Instance Profile (IIP) to associate with the instances.

instance_profile_name

(string) – The name of the IAM Instance Profile (IIP) to associate with the instances.

ebs_optimized

(bool) – Whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn’t available with all instance types.

network_interfaces

(boto.ec2.networkinterface.NetworkInterfaceCollection) – A NetworkInterfaceCollection data structure containing the ENI specifications for the instance.

network_interface_id

(string) - ID of the network interface to attach to the instance

network_interface_name

(string) - Name of the network interface to attach to the instance

salt.modules.boto_ec2.set_attribute(attribute, attribute_value, instance_name=None, instance_id=None, region=None, key=None, keyid=None, profile=None, filters=None)¶

Set an EC2 instance attribute. Returns whether the operation succeeded or not.

CLI Example:

salt myminion boto_ec2.set_attribute sourceDestCheck False instance_name=my_instance

Available attributes:

instanceType
kernel
ramdisk
userData
disableApiTermination
instanceInitiatedShutdownBehavior
rootDeviceName
blockDeviceMapping
productCodes
sourceDestCheck
groupSet
ebsOptimized
sriovNetSupport

salt.modules.boto_ec2.set_volumes_tags(tag_maps, authoritative=False, dry_run=False, region=None, key=None, keyid=None, profile=None)¶

New in version 2016.11.0.

tag_maps (list): List of dicts of filters and tags, where 'filters' is a dict suitable for passing to the 'filters' argument of get_all_volumes() above, and 'tags' is a dict of tags to be set on volumes (via create_tags/delete_tags) as matched by the given filters. The filter syntax is extended to permit passing either a list of volume_ids or an instance_name (with instance_name being the Name tag of the instance to which the desired volumes are mapped). Each mapping in the list is applied separately, so multiple sets of volumes can be all tagged differently with one call to this function. If filtering by instance Name, You may additionally limit the instances matched by passing in a list of desired instance states. The default set of states is ('pending', 'rebooting', 'running', 'stopping', 'stopped').

YAML example fragment:

- filters:
    attachment.instance_id: i-abcdef12
  tags:
    Name: dev-int-abcdef12.aws-foo.com
- filters:
    attachment.device: /dev/sdf
  tags:
    ManagedSnapshots: true
    BillingGroup: bubba.hotep@aws-foo.com
  in_states:
  - stopped
  - terminated
- filters:
    instance_name: prd-foo-01.aws-foo.com
  tags:
    Name: prd-foo-01.aws-foo.com
    BillingGroup: infra-team@aws-foo.com
- filters:
    volume_ids: [ vol-12345689, vol-abcdef12 ]
  tags:
    BillingGroup: infra-team@aws-foo.com

authoritative (bool): If true, any existing tags on the matched volumes, and not explicitly requested here, will be removed.
dry_run (bool): If true, don't change anything, just return a dictionary describing any changes which would have been applied.
returns (dict): A dict describing status and any changes.

salt.modules.boto_ec2.terminate(instance_id=None, name=None, region=None, key=None, keyid=None, profile=None, filters=None)¶

Terminate the instance described by instance_id or name.

CLI Example:

salt myminion boto_ec2.terminate name=myinstance
salt myminion boto_ec2.terminate instance_id=i-a46b9f

salt.modules.boto_ec2.unassign_private_ip_addresses(network_interface_name=None, network_interface_id=None, private_ip_addresses=None, region=None, key=None, keyid=None, profile=None)¶

Unassigns one or more secondary private IP addresses from a network interface

network_interface_id: (string) - ID of the network interface to associate the IP with (exclusive with 'network_interface_name')
network_interface_name: (string) - Name of the network interface to associate the IP with (exclusive with 'network_interface_id')
private_ip_addresses: (list) - Assigns the specified IP addresses as secondary IP addresses to the network interface.
returns: (bool) - True on success, False on failure.

CLI Example:

salt myminion boto_ec2.unassign_private_ip_addresses network_interface_name=my_eni private_ip_addresses=private_ip

New in version 2017.7.0.

Generated on October 23, 2024 at 09:02:06 UTC.

You are viewing docs for the latest stable release, 3007.1. Switch to docs for the previous stable release, 3006.9, or to a recent doc build from the master branch.

saltproject.io