awsdoc

Documentation

Index

• Variables
• func AwlessCommandDefinitionsDoc(action, entity, fallbackDef string) string
• func AwlessExamplesDoc(action, entity string) string
• func TemplateParamsDoc(action, entity, param string) (string, bool)
• func TemplateParamsDocWithEnums(action, entity, param string) (string, bool)
• type ParamType

Variables

var CommandDefinitionsDoc = map[string]string{
	"copy.image":                 "Copy an EC2 image from given source region to current awless region",
	"create.classicloadbalancer": "Create a ELB Classic Loadbalancer (recommended only for EC2 Classic instances).\n\nYou should favor newer AWS load balancers. See `awless create loadbalancer -h`.",
}

var EnumDoc = map[string][]string{}/* 129 elements not displayed */

var ParamTypeDoc = map[string]*ParamType{
	"attach.mfadevice.user": {ResourceType: cloud.User, PropertyName: properties.Name},

	"attach.policy.group": {ResourceType: cloud.Group, PropertyName: properties.Name},
	"attach.policy.role":  {ResourceType: cloud.Role, PropertyName: properties.Name},
	"attach.policy.user":  {ResourceType: cloud.User, PropertyName: properties.Name},
	"attach.policy.arn":   {ResourceType: cloud.Policy, PropertyName: properties.Arn},

	"attach.user.name":  {ResourceType: cloud.User, PropertyName: properties.Name},
	"attach.user.group": {ResourceType: cloud.Group, PropertyName: properties.Name},

	"attach.role.instanceprofile": {ResourceType: cloud.InstanceProfile, PropertyName: properties.Name},

	"create.accesskey.user": {ResourceType: cloud.User, PropertyName: properties.Name},

	"create.instance.role": {ResourceType: cloud.Role, PropertyName: properties.Name},

	"create.record.values": {ResourceType: cloud.Record, PropertyName: properties.Records},

	"delete.policy.arn":   {ResourceType: cloud.Policy, PropertyName: properties.Arn},
	"detach.policy.arn":   {ResourceType: cloud.Policy, PropertyName: properties.Arn},
	"detach.policy.group": {ResourceType: cloud.Group, PropertyName: properties.Name},
	"detach.policy.role":  {ResourceType: cloud.Role, PropertyName: properties.Name},
	"detach.policy.user":  {ResourceType: cloud.User, PropertyName: properties.Name},

	"detach.role.instanceprofile": {ResourceType: cloud.InstanceProfile, PropertyName: properties.Name},

	"update.policy.arn": {ResourceType: cloud.Policy, PropertyName: properties.Arn},

	"update.securitygroup.cidr": {ResourceType: cloud.Subnet, PropertyName: properties.CIDR},
}

Functions

func AwlessCommandDefinitionsDoc

func AwlessCommandDefinitionsDoc(action, entity, fallbackDef string) string

func AwlessExamplesDoc

func AwlessExamplesDoc(action, entity string) string

func TemplateParamsDoc

func TemplateParamsDoc(action, entity, param string) (string, bool)

func TemplateParamsDocWithEnums

func TemplateParamsDocWithEnums(action, entity, param string) (string, bool)

Types

type ParamType

type ParamType struct {
	ResourceType, PropertyName string
}