Inputs & Outputs
AWSClient
-
Contains AWS API connection details
-
It is used as an input to many of the actions in this plugin
Generating API Access Keys
See this AWS article if you need to generate API access keys.
Supplying Credentials
You should always use a PPA Vault integration to provide credentials to a plugin action.
Required Keys
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
Example
1 2 3 |
|
EC2IPRange
- Contains IP range properties associated with an inbound/outbound rule
EC2IPRange Keys
cidr_ip: allowed source/destination CIDR address
description: description for the IP range associated with the rule
YAML Structure
1 2 |
|
EC2InboundRule
- Contains properties for an inbound rule associated with an EC2 security group
EC2InboundRule Keys
protocol: rule protocol (tcp
, udp
, or -1
for any)
ip_ranges: list of EC2IPRanges associated with the rule
from_port: rule start port
to_port: rule end port
YAML Structure
1 2 3 4 5 6 |
|
EC2Instance
- Contains EC2 instance properties
EC2Instance Keys
image_id: ID of the image used by the instance
instance_id: ID of the instance
instance_type: type of the instance
key_name: name of the public/private key pair associated with the instance
launch_time: time of launch (format: 06:45:23 09/07/2020
)
monitoring: state of instance monitoring (enabled
or disabled
)
platform: platform type (windows
or None)
private_dns_name: instance private dns name
private_ip_address: instance private IP address
public_dns_name: instance public DNS name
state: instance state (starting
, running
, stopping
, stopped
, or terminated
)
vpc_id: ID of the instance VPC
subnet_id: ID of the subnet the instance was launched in
security_groups: list of dictionaries containing the name
& group_id
of each EC2SecurityGroup associated with the instance
root_device_type: type of the instance root volume (ebs
or an instance store volume)
tags: a list of dictionaries containing the key
& value
of each tag associated with the instance
cpu_options: instance CPU options dictionary containing core_count
& threads_per_core
YAML Structure
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
|
EC2InstanceProcessorInfo
- Contains EC2 Instance type processor information
EC2InstanceProcessorInfo Keys
supported_architectures: a list of processor architectures supported by the instance type
sustained_clock_speed: the sustained clock speed in GHz
YAML Structure
1 2 3 |
|
EC2InstanceType
- Contains properties for an EC2 Instance type
EC2InstanceType Keys
name: the name of the instance type
bare_metal: indicates whether the instance type is bare metal
free_tier_eligible: indicates whether the instance type is free tier eligible
supported_usage_classes: indicates whether the instance type is offered for spot, on-demand, or both
hypervisor: the instance type hypervisor (usually xen or nitro)
memory: the memory of the instance type in MiB
vcpu_info: an EC2InstanceVCPUInfo dictionary containing instance type VCPU details
processor_info: an EC2InstanceProcessorInfo dictionary containing instance type processor details
YAML Structure
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 |
|
EC2InstanceVCPUInfo
- Contains EC2 Instance type VCPU information
EC2InstanceVCPUInfo Keys
default_vcpus: the default number of VCPUs
default_cores: the default number of VCPU cores
default_threads_per_core: the default number of threads per VCPU core
valid_cores: a list of valid core numbers
valid_threads_per_core: a list of valid threads per core
YAML Structure
1 2 3 4 5 6 7 8 |
|
EC2KeyPair
- Contains EC2 key pair properties
EC2KeyPair Keys
name: name of the key pair
key_pair_id: the ID of the key pair
fingerprint: the key fingerprint
tags: a list of dictionaries containing the key
& value
of each tag associated with the key pair
YAML Structure
1 2 3 4 5 6 |
|
EC2OutboundRule
- Contains properties for an outbound rule associated with an EC2 security group
EC2OutboundRule Keys
protocol: rule protocol (tcp
, udp
, or -1
for any)
ip_ranges: list of EC2IPRanges associated with the rule
from_port: rule start port
to_port: rule end port
YAML Structure
1 2 3 4 5 6 |
|
EC2SecurityGroup
- Contains EC2 security group properties
EC2SecurityGroup Keys
description: description of the security group
name: name of the security group
owner_id: ID of the security group owner
group_id: ID of the security group
vpc_id: ID of the security group VPC
inbound_rules: a list of EC2InboundRules configured in the security group
outbound_rules: a list of EC2OutboundRules configured in the security group
tags: a list of dictionaries containing the key
& value
of each tag associated with the security group
YAML Structure
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
|
EC2VPC
- Contains properties for an EC2 Virtual Private Cloud
EC2VPC Keys
cidr_block: CIDR address range for the VPC
is_default: indicates whether it is the default VPC
state: VPC state
vpc_id: ID of the VPC
tags: a list of dictionaries containing the key
& value
of each tag associated with the VPC
YAML Structure
1 2 3 4 5 6 7 |
|
IAMGroup
- Contains IAM group information
Group Keys
name: the name of the group
group_id: the group's ID
arn: the Amazon resource name
created_at: the date & time the group was created
YAML Structure
1 2 3 4 |
|
IAMUser
- Contains IAM user information
User Keys
name: the name of the user
user_id: the user's ID
created_at: the date & time the user was created
password_last_user: the date & time the password was last used (or null
if never used)
YAML Structure
1 2 3 4 |
|