AWS::ResDef type

AWS Resource definition

Direct parent types

ResDef
Abstract resource definition
Direct subtypes: 2

Direct children types

AWS::Vpc
Declarative primitive for referencing AWS VPC resources. Supported anchor items: VpcId, Tags, CidrBlock, IsDefault. Supported properties: Tags, CidrBlock (assert only).
AWS::Igw
Declarative primitive for referencing AWS Internet Gateway resources. Supported anchor items: Tags, Attachments, InternetGatewayId. Supported properties: Tags, Attachments.
AWS::RouteTable
Declarative primitive for referencing AWS RouteTable resources. Creation is not supported yet. Supported anchor items: Tags, VpcId. Supported properties: Routes.
AWS::SecGroup
Declarative primitive for referencing AWS Security Group resources. Supported anchor items: Name, VpcId (can be Vpc resource), Description (required for creation), Tags, GroupId Supported properties: Tags, CidrBlock (assert only).
AWS::Subnet
Declarative primitive for referencing AWS Subnet resources. Supported anchor items: VpcId (required for creation), Tags, CidrBlock (required for creation), AvailabilityZone. Supported properties: Tags.
AWS::Image
Declarative primitive for referencing AWS AMI resources. Supported anchor items: State (defaults to "available"), OwnerId, Name (Str or Pfx), RootDeviceType, VirtualizationType (defaults to hvm), VolumeType, ImageId. Supported properties: (not supported yet).
AWS::Instance
Declarative primitive for referencing AWS Instance resources. Supported anchor items: VpcId, State (defaults to pending and running, pass "*" for all states except shutting-down and terminated, pass null for all states), InstanceId, ImageId (required for creation), KeyName, SubnetId, InstanceType, PublicIpAddress (Bool), PrivateIpAddresses, UserData Supported properties: Tags, SecurityGroups, State (running/stopped), SourceDestCheck.
AWS::Elb
Declarative primitive for referencing AWS Elastic Load Balancer resources. Supported anchor items: LoadBalancerName, Name (required for creation, synthetic, probably will be removed), Tags, ListenerDescriptions (can not be used for lookup but required for creation), Subnets (can not be used for lookup but required for creation), AvailabilityZones (not implemented yet). Supported properties: Tags, Instances, SecurityGroups, ListenerDescriptions
AWS::Zone
Declarative primitive for referencing AWS Route53 hosted zones resources. Supported anchor items: Name, ZoneName (in future _ZoneName), Type, SetIdentifier, Region.
AWS::RecordSet
Declarative primitive for referencing AWS Route53 RecordSet resources. Supported anchor items: Name, ZoneName (in future _ZoneName), Type, SetIdentifier, Region. Supported properties (not sure): Type, SetIdentifier, Region.
AWS::Volume
Declarative primitive for referencing AWS EC2 Volumes. Supported anchor items: VolumeId, _InstanceId, State, SnapshotId, Tags, AvailabilityZone, VolumeType, Size Supported properties: (converge is not implemented yet). Resources are listed in 'CreateTime' order.
AWS::Snapshot
Declarative primitive for referencing AWS EC2 Snapshot resources. Supported anchor items: Tags, Description, OwnerId, OwnerIds, SnapshotId, State, VolumeId, VolumeSize, _AMI (extracted from Description "Created by CreateImage ...") Supported properties: (converge is not implemented yet). Warning: Owner ids starting with zero must be passed as strings.
AWS::Eip
Declarative primitive for referencing AWS Elastic IP resources. Supported anchor items: InstanceId
AWS::Any (_Any)
EXPERIMENTAL! Do not use!

Methods

init(rd:AWS::ResDef, **kw:Hash) Source: autoload/AWS.ngs:168
Initialize ResDef from kw. Defaults: null for .regions and empty hash for .Tags
init(rd:AWS::ResDef, _ngs_name:Str) Source: autoload/AWS.ngs:180
Initialize ResDef from _ngs_name. Sets .regions to null, .Tags to empty hash and .Name to _ngs_name.
init(rd:AWS::ResDef, _ngs_tags:Hash) Source: autoload/AWS.ngs:183
Initialize ResDef from _ngs_tags. Sets .regions to null and .Tags to _ngs_tags.
run(rd:AWS::ResDef, log_pfx:Str, cp:CommandsPipeline, do_decode:Any=true)internal Source: autoload/AWS.ngs:190
Run an external command related to the resource definition. Will not run the command if rd.dry_run is true.

Parameters

do_decodeWhether to decode the output

Returns

Either parsed output or finished CommandsPipeline (processes in CommandsPipeline finished)