params

Documentation

Index

• type Cluster
• type Container
• type ContainerPort
• type GatewayParameters
• type LBListener
• type LBProtocol
• type LBTargetGroup
• type LBType
• type LoadBalancer
• type NetworkPartitionParameters
• type Region
• type Service
• type Subnet
• type VPC

Types

type Cluster

type Cluster struct {
	pgocomp.Meta
	Services []Service
}

Cluster are parameters to create an ECS Cluster

type Container

type Container struct {
	Name         string
	Image        string
	CPU          int
	Memory       int
	PortMappings []ContainerPort
	Environment  map[string]string
}

Container defines containers to be used in the Infra

type ContainerPort

type ContainerPort struct {
	ContainerPort     int
	AppProtocol       string
	TargetGroupLookup string
}

ContainerPort are the ports the the container exposes

type GatewayParameters

type GatewayParameters struct {
	pgocomp.Meta
}

GatewayParameters are parameters used by the CreateSubnet function

type LBListener

type LBListener struct {
	pgocomp.Meta
	Port                  int
	Protocol              LBProtocol
	TargetGroupLookupName string
}

LBListener is the paramenters for a listener

type LBProtocol

type LBProtocol string

LBProtocol is the network protocol tobe balanced

const (
	//TCP is the tcp protocol
	TCP LBProtocol = "TCP"
)

type LBTargetGroup

type LBTargetGroup struct {
	pgocomp.Meta
	Port       int
	Protocol   LBProtocol
	TargetType string
}

LBTargetGroup is the paramenters for a listener

type LBType

type LBType string

LBType is the type of the network load balander

const (
	//Classic is the classic elastic load balancer that works on layer 4 and 7
	Classic LBType = "gateway"

	//Application is the application load balancer that works on layer 7
	Application LBType = "application"

	//Network is the network load balancer that works on layer 4
	Network LBType = "network"
)

type LoadBalancer

type LoadBalancer struct {
	pgocomp.Meta
	Type      LBType
	Listeners []LBListener
}

LoadBalancer are parameters used by the CreateSubnet function

type NetworkPartitionParameters

type NetworkPartitionParameters struct {
	pgocomp.Meta
	Subnets        []Subnet
	LoadBalancers  []LoadBalancer
	LBTargetGroups []LBTargetGroup
	ECSClusters    []Cluster
}

NetworkPartitionParameters defines the parameter for a network block, like public or private

type Region

type Region struct {
	pgocomp.Meta
	Region     string
	CidrBlock  string
	Partitions []NetworkPartitionParameters
}

Region are the parameters of the function NewBasicNetworkComponent

type Service

type Service struct {
	pgocomp.Meta
	Name           string
	DesiredCount   int
	CPU            int
	Memory         int
	AssignPublicIP bool
	Containers     []Container
}

Service defines containers to be used in the Infra

type Subnet

type Subnet struct {
	pgocomp.Meta
	CidrBlock        string
	AvailabilityZone string
	IsPublic         bool
}

Subnet are parameters used by the CreateSubnet function

type VPC

type VPC struct {
	pgocomp.Meta
	CidrBlock string
}

VPC are parameters used by the CreateVPC function