Documentation ¶
Overview ¶
Package ecs provides a client for Amazon EC2 Container Service.
Index ¶
- Constants
- type Attribute
- type Cluster
- type Container
- type ContainerDefinition
- type ContainerInstance
- type ContainerOverride
- type CreateClusterInput
- type CreateClusterOutput
- type CreateServiceInput
- type CreateServiceOutput
- type DeleteClusterInput
- type DeleteClusterOutput
- type DeleteServiceInput
- type DeleteServiceOutput
- type Deployment
- type DeploymentConfiguration
- type DeregisterContainerInstanceInput
- type DeregisterContainerInstanceOutput
- type DeregisterTaskDefinitionInput
- type DeregisterTaskDefinitionOutput
- type DescribeClustersInput
- type DescribeClustersOutput
- type DescribeContainerInstancesInput
- type DescribeContainerInstancesOutput
- type DescribeServicesInput
- type DescribeServicesOutput
- type DescribeTaskDefinitionInput
- type DescribeTaskDefinitionOutput
- type DescribeTasksInput
- type DescribeTasksOutput
- type DiscoverPollEndpointInput
- type DiscoverPollEndpointOutput
- type ECS
- func (c *ECS) CreateCluster(input *CreateClusterInput) (*CreateClusterOutput, error)
- func (c *ECS) CreateClusterRequest(input *CreateClusterInput) (req *request.Request, output *CreateClusterOutput)
- func (c *ECS) CreateService(input *CreateServiceInput) (*CreateServiceOutput, error)
- func (c *ECS) CreateServiceRequest(input *CreateServiceInput) (req *request.Request, output *CreateServiceOutput)
- func (c *ECS) DeleteCluster(input *DeleteClusterInput) (*DeleteClusterOutput, error)
- func (c *ECS) DeleteClusterRequest(input *DeleteClusterInput) (req *request.Request, output *DeleteClusterOutput)
- func (c *ECS) DeleteService(input *DeleteServiceInput) (*DeleteServiceOutput, error)
- func (c *ECS) DeleteServiceRequest(input *DeleteServiceInput) (req *request.Request, output *DeleteServiceOutput)
- func (c *ECS) DeregisterContainerInstance(input *DeregisterContainerInstanceInput) (*DeregisterContainerInstanceOutput, error)
- func (c *ECS) DeregisterContainerInstanceRequest(input *DeregisterContainerInstanceInput) (req *request.Request, output *DeregisterContainerInstanceOutput)
- func (c *ECS) DeregisterTaskDefinition(input *DeregisterTaskDefinitionInput) (*DeregisterTaskDefinitionOutput, error)
- func (c *ECS) DeregisterTaskDefinitionRequest(input *DeregisterTaskDefinitionInput) (req *request.Request, output *DeregisterTaskDefinitionOutput)
- func (c *ECS) DescribeClusters(input *DescribeClustersInput) (*DescribeClustersOutput, error)
- func (c *ECS) DescribeClustersRequest(input *DescribeClustersInput) (req *request.Request, output *DescribeClustersOutput)
- func (c *ECS) DescribeContainerInstances(input *DescribeContainerInstancesInput) (*DescribeContainerInstancesOutput, error)
- func (c *ECS) DescribeContainerInstancesRequest(input *DescribeContainerInstancesInput) (req *request.Request, output *DescribeContainerInstancesOutput)
- func (c *ECS) DescribeServices(input *DescribeServicesInput) (*DescribeServicesOutput, error)
- func (c *ECS) DescribeServicesRequest(input *DescribeServicesInput) (req *request.Request, output *DescribeServicesOutput)
- func (c *ECS) DescribeTaskDefinition(input *DescribeTaskDefinitionInput) (*DescribeTaskDefinitionOutput, error)
- func (c *ECS) DescribeTaskDefinitionRequest(input *DescribeTaskDefinitionInput) (req *request.Request, output *DescribeTaskDefinitionOutput)
- func (c *ECS) DescribeTasks(input *DescribeTasksInput) (*DescribeTasksOutput, error)
- func (c *ECS) DescribeTasksRequest(input *DescribeTasksInput) (req *request.Request, output *DescribeTasksOutput)
- func (c *ECS) DiscoverPollEndpoint(input *DiscoverPollEndpointInput) (*DiscoverPollEndpointOutput, error)
- func (c *ECS) DiscoverPollEndpointRequest(input *DiscoverPollEndpointInput) (req *request.Request, output *DiscoverPollEndpointOutput)
- func (c *ECS) ListClusters(input *ListClustersInput) (*ListClustersOutput, error)
- func (c *ECS) ListClustersPages(input *ListClustersInput, ...) error
- func (c *ECS) ListClustersRequest(input *ListClustersInput) (req *request.Request, output *ListClustersOutput)
- func (c *ECS) ListContainerInstances(input *ListContainerInstancesInput) (*ListContainerInstancesOutput, error)
- func (c *ECS) ListContainerInstancesPages(input *ListContainerInstancesInput, ...) error
- func (c *ECS) ListContainerInstancesRequest(input *ListContainerInstancesInput) (req *request.Request, output *ListContainerInstancesOutput)
- func (c *ECS) ListServices(input *ListServicesInput) (*ListServicesOutput, error)
- func (c *ECS) ListServicesPages(input *ListServicesInput, ...) error
- func (c *ECS) ListServicesRequest(input *ListServicesInput) (req *request.Request, output *ListServicesOutput)
- func (c *ECS) ListTaskDefinitionFamilies(input *ListTaskDefinitionFamiliesInput) (*ListTaskDefinitionFamiliesOutput, error)
- func (c *ECS) ListTaskDefinitionFamiliesPages(input *ListTaskDefinitionFamiliesInput, ...) error
- func (c *ECS) ListTaskDefinitionFamiliesRequest(input *ListTaskDefinitionFamiliesInput) (req *request.Request, output *ListTaskDefinitionFamiliesOutput)
- func (c *ECS) ListTaskDefinitions(input *ListTaskDefinitionsInput) (*ListTaskDefinitionsOutput, error)
- func (c *ECS) ListTaskDefinitionsPages(input *ListTaskDefinitionsInput, ...) error
- func (c *ECS) ListTaskDefinitionsRequest(input *ListTaskDefinitionsInput) (req *request.Request, output *ListTaskDefinitionsOutput)
- func (c *ECS) ListTasks(input *ListTasksInput) (*ListTasksOutput, error)
- func (c *ECS) ListTasksPages(input *ListTasksInput, ...) error
- func (c *ECS) ListTasksRequest(input *ListTasksInput) (req *request.Request, output *ListTasksOutput)
- func (c *ECS) RegisterContainerInstance(input *RegisterContainerInstanceInput) (*RegisterContainerInstanceOutput, error)
- func (c *ECS) RegisterContainerInstanceRequest(input *RegisterContainerInstanceInput) (req *request.Request, output *RegisterContainerInstanceOutput)
- func (c *ECS) RegisterTaskDefinition(input *RegisterTaskDefinitionInput) (*RegisterTaskDefinitionOutput, error)
- func (c *ECS) RegisterTaskDefinitionRequest(input *RegisterTaskDefinitionInput) (req *request.Request, output *RegisterTaskDefinitionOutput)
- func (c *ECS) RunTask(input *RunTaskInput) (*RunTaskOutput, error)
- func (c *ECS) RunTaskRequest(input *RunTaskInput) (req *request.Request, output *RunTaskOutput)
- func (c *ECS) StartTask(input *StartTaskInput) (*StartTaskOutput, error)
- func (c *ECS) StartTaskRequest(input *StartTaskInput) (req *request.Request, output *StartTaskOutput)
- func (c *ECS) StopTask(input *StopTaskInput) (*StopTaskOutput, error)
- func (c *ECS) StopTaskRequest(input *StopTaskInput) (req *request.Request, output *StopTaskOutput)
- func (c *ECS) SubmitContainerStateChange(input *SubmitContainerStateChangeInput) (*SubmitContainerStateChangeOutput, error)
- func (c *ECS) SubmitContainerStateChangeRequest(input *SubmitContainerStateChangeInput) (req *request.Request, output *SubmitContainerStateChangeOutput)
- func (c *ECS) SubmitTaskStateChange(input *SubmitTaskStateChangeInput) (*SubmitTaskStateChangeOutput, error)
- func (c *ECS) SubmitTaskStateChangeRequest(input *SubmitTaskStateChangeInput) (req *request.Request, output *SubmitTaskStateChangeOutput)
- func (c *ECS) UpdateContainerAgent(input *UpdateContainerAgentInput) (*UpdateContainerAgentOutput, error)
- func (c *ECS) UpdateContainerAgentRequest(input *UpdateContainerAgentInput) (req *request.Request, output *UpdateContainerAgentOutput)
- func (c *ECS) UpdateService(input *UpdateServiceInput) (*UpdateServiceOutput, error)
- func (c *ECS) UpdateServiceRequest(input *UpdateServiceInput) (req *request.Request, output *UpdateServiceOutput)
- func (c *ECS) WaitUntilServicesInactive(input *DescribeServicesInput) error
- func (c *ECS) WaitUntilServicesStable(input *DescribeServicesInput) error
- func (c *ECS) WaitUntilTasksRunning(input *DescribeTasksInput) error
- func (c *ECS) WaitUntilTasksStopped(input *DescribeTasksInput) error
- type Failure
- type HostEntry
- type HostVolumeProperties
- type KeyValuePair
- type ListClustersInput
- type ListClustersOutput
- type ListContainerInstancesInput
- type ListContainerInstancesOutput
- type ListServicesInput
- type ListServicesOutput
- type ListTaskDefinitionFamiliesInput
- type ListTaskDefinitionFamiliesOutput
- type ListTaskDefinitionsInput
- type ListTaskDefinitionsOutput
- type ListTasksInput
- type ListTasksOutput
- type LoadBalancer
- type LogConfiguration
- type MountPoint
- type NetworkBinding
- type PortMapping
- type RegisterContainerInstanceInput
- type RegisterContainerInstanceOutput
- type RegisterTaskDefinitionInput
- type RegisterTaskDefinitionOutput
- type Resource
- type RunTaskInput
- type RunTaskOutput
- type Service
- type ServiceEvent
- type StartTaskInput
- type StartTaskOutput
- type StopTaskInput
- type StopTaskOutput
- type SubmitContainerStateChangeInput
- type SubmitContainerStateChangeOutput
- type SubmitTaskStateChangeInput
- type SubmitTaskStateChangeOutput
- type Task
- type TaskDefinition
- type TaskOverride
- type Ulimit
- type UpdateContainerAgentInput
- type UpdateContainerAgentOutput
- type UpdateServiceInput
- type UpdateServiceOutput
- type VersionInfo
- type Volume
- type VolumeFrom
Examples ¶
- ECS.CreateCluster
- ECS.CreateService
- ECS.DeleteCluster
- ECS.DeleteService
- ECS.DeregisterContainerInstance
- ECS.DeregisterTaskDefinition
- ECS.DescribeClusters
- ECS.DescribeContainerInstances
- ECS.DescribeServices
- ECS.DescribeTaskDefinition
- ECS.DescribeTasks
- ECS.DiscoverPollEndpoint
- ECS.ListClusters
- ECS.ListContainerInstances
- ECS.ListServices
- ECS.ListTaskDefinitionFamilies
- ECS.ListTaskDefinitions
- ECS.ListTasks
- ECS.RegisterContainerInstance
- ECS.RegisterTaskDefinition
- ECS.RunTask
- ECS.StartTask
- ECS.StopTask
- ECS.SubmitContainerStateChange
- ECS.SubmitTaskStateChange
- ECS.UpdateContainerAgent
- ECS.UpdateService
Constants ¶
const ( // @enum AgentUpdateStatus AgentUpdateStatusPending = "PENDING" // @enum AgentUpdateStatus AgentUpdateStatusStaging = "STAGING" // @enum AgentUpdateStatus AgentUpdateStatusStaged = "STAGED" // @enum AgentUpdateStatus AgentUpdateStatusUpdating = "UPDATING" // @enum AgentUpdateStatus AgentUpdateStatusUpdated = "UPDATED" // @enum AgentUpdateStatus AgentUpdateStatusFailed = "FAILED" )
const ( // @enum DesiredStatus DesiredStatusRunning = "RUNNING" // @enum DesiredStatus DesiredStatusPending = "PENDING" // @enum DesiredStatus DesiredStatusStopped = "STOPPED" )
const ( // @enum LogDriver LogDriverJsonFile = "json-file" // @enum LogDriver LogDriverSyslog = "syslog" // @enum LogDriver LogDriverJournald = "journald" // @enum LogDriver LogDriverGelf = "gelf" // @enum LogDriver LogDriverFluentd = "fluentd" )
const ( // @enum SortOrder SortOrderAsc = "ASC" // @enum SortOrder SortOrderDesc = "DESC" )
const ( // @enum TaskDefinitionStatus TaskDefinitionStatusActive = "ACTIVE" // @enum TaskDefinitionStatus TaskDefinitionStatusInactive = "INACTIVE" )
const ( // @enum TransportProtocol TransportProtocolTcp = "tcp" // @enum TransportProtocol TransportProtocolUdp = "udp" )
const ( // @enum UlimitName UlimitNameCore = "core" // @enum UlimitName UlimitNameCpu = "cpu" // @enum UlimitName UlimitNameData = "data" // @enum UlimitName UlimitNameFsize = "fsize" // @enum UlimitName UlimitNameLocks = "locks" // @enum UlimitName UlimitNameMemlock = "memlock" // @enum UlimitName UlimitNameMsgqueue = "msgqueue" // @enum UlimitName UlimitNameNice = "nice" // @enum UlimitName UlimitNameNofile = "nofile" // @enum UlimitName UlimitNameNproc = "nproc" // @enum UlimitName UlimitNameRss = "rss" // @enum UlimitName UlimitNameRtprio = "rtprio" // @enum UlimitName UlimitNameRttime = "rttime" // @enum UlimitName UlimitNameSigpending = "sigpending" // @enum UlimitName UlimitNameStack = "stack" )
const ServiceName = "ecs"
A ServiceName is the name of the service the client will make API calls to.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Attribute ¶
type Attribute struct { // The name of the container instance attribute. Name *string `locationName:"name" type:"string" required:"true"` // The value of the container instance attribute (at this time, the value here // is Null, but this could change in future revisions for expandability). Value *string `locationName:"value" type:"string"` // contains filtered or unexported fields }
The attributes applicable to a container instance when it is registered.
type Cluster ¶
type Cluster struct { // The number of services that are running on the cluster in an ACTIVE state. // You can view these services with ListServices. ActiveServicesCount *int64 `locationName:"activeServicesCount" type:"integer"` // The Amazon Resource Name (ARN) that identifies the cluster. The ARN contains // the arn:aws:ecs namespace, followed by the region of the cluster, the AWS // account ID of the cluster owner, the cluster namespace, and then the cluster // name. For example, arn:aws:ecs:region:012345678910:cluster/test. ClusterArn *string `locationName:"clusterArn" type:"string"` // A user-generated string that you use to identify your cluster. ClusterName *string `locationName:"clusterName" type:"string"` // The number of tasks in the cluster that are in the PENDING state. PendingTasksCount *int64 `locationName:"pendingTasksCount" type:"integer"` // The number of container instances registered into the cluster. RegisteredContainerInstancesCount *int64 `locationName:"registeredContainerInstancesCount" type:"integer"` // The number of tasks in the cluster that are in the RUNNING state. RunningTasksCount *int64 `locationName:"runningTasksCount" type:"integer"` // The status of the cluster. The valid values are ACTIVE or INACTIVE. ACTIVE // indicates that you can register container instances with the cluster and // the associated instances can accept tasks. Status *string `locationName:"status" type:"string"` // contains filtered or unexported fields }
A regional grouping of one or more container instances on which you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.
type Container ¶
type Container struct { // The Amazon Resource Name (ARN) of the container. ContainerArn *string `locationName:"containerArn" type:"string"` // The exit code returned from the container. ExitCode *int64 `locationName:"exitCode" type:"integer"` // The last known status of the container. LastStatus *string `locationName:"lastStatus" type:"string"` // The name of the container. Name *string `locationName:"name" type:"string"` // The network bindings associated with the container. NetworkBindings []*NetworkBinding `locationName:"networkBindings" type:"list"` // A short (255 max characters) human-readable string to provide additional // detail about a running or stopped container. Reason *string `locationName:"reason" type:"string"` // The Amazon Resource Name (ARN) of the task. TaskArn *string `locationName:"taskArn" type:"string"` // contains filtered or unexported fields }
A Docker container that is part of a task.
type ContainerDefinition ¶
type ContainerDefinition struct { // The command that is passed to the container. This parameter maps to Cmd in // the Create a container (https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/reference/api/docker_remote_api_v1.19/) // and the COMMAND parameter to docker run (https://docs.docker.com/reference/commandline/run/). // For more information, see https://docs.docker.com/reference/builder/#cmd // (https://docs.docker.com/reference/builder/#cmd). Command []*string `locationName:"command" type:"list"` // The number of cpu units reserved for the container. A container instance // has 1,024 cpu units for every CPU core. This parameter specifies the minimum // amount of CPU to reserve for a container, and containers share unallocated // CPU units with other containers on the instance with the same ratio as their // allocated amount. This parameter maps to CpuShares in the Create a container // (https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/reference/api/docker_remote_api_v1.19/) // and the --cpu-shares option to docker run (https://docs.docker.com/reference/commandline/run/). // // You can determine the number of CPU units that are available per EC2 instance // type by multiplying the vCPUs listed for that instance type on the Amazon // EC2 Instances (http://aws.amazon.com/ec2/instance-types/) detail page by // 1,024. // // For example, if you run a single-container task on a single-core instance // type with 512 CPU units specified for that container, and that is the only // task running on the container instance, that container could use the full // 1,024 CPU unit share at any given time. However, if you launched another // copy of the same task on that container instance, each task would be guaranteed // a minimum of 512 CPU units when needed, and each container could float to // higher CPU usage if the other container was not using it, but if both tasks // were 100% active all of the time, they would be limited to 512 CPU units. // // The Docker daemon on the container instance uses the CPU value to calculate // the relative CPU share ratios for running containers. For more information, // see CPU share constraint (https://docs.docker.com/reference/run/#cpu-share-constraint) // in the Docker documentation. The minimum valid CPU share value that the Linux // kernel allows is 2; however, the CPU parameter is not required, and you can // use CPU values below 2 in your container definitions. For CPU values below // 2 (including null), the behavior varies based on your Amazon ECS container // agent version: // // Agent versions less than or equal to 1.1.0: Null and zero CPU values are // passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU // values of 1 are passed to Docker as 1, which the Linux kernel converts to // 2 CPU shares. Agent versions greater than or equal to 1.2.0: Null, zero, // and CPU values of 1 are passed to Docker as 2. Cpu *int64 `locationName:"cpu" type:"integer"` // When this parameter is true, networking is disabled within the container. // This parameter maps to NetworkDisabled in the Create a container (https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/reference/api/docker_remote_api_v1.19/). DisableNetworking *bool `locationName:"disableNetworking" type:"boolean"` // A list of DNS search domains that are presented to the container. This parameter // maps to DnsSearch in the Create a container (https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/reference/api/docker_remote_api_v1.19/) // and the --dns-search option to docker run (https://docs.docker.com/reference/commandline/run/). DnsSearchDomains []*string `locationName:"dnsSearchDomains" type:"list"` // A list of DNS servers that are presented to the container. This parameter // maps to Dns in the Create a container (https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/reference/api/docker_remote_api_v1.19/) // and the --dns option to docker run (https://docs.docker.com/reference/commandline/run/). DnsServers []*string `locationName:"dnsServers" type:"list"` // A key/value map of labels to add to the container. This parameter maps to // Labels in the Create a container (https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/reference/api/docker_remote_api_v1.19/) // and the --label option to docker run (https://docs.docker.com/reference/commandline/run/). // This parameter requires version 1.18 of the Docker Remote API or greater // on your container instance. To check the Docker Remote API version on your // container instance, log into your container instance and run the following // command: sudo docker version | grep "Server API version" DockerLabels map[string]*string `locationName:"dockerLabels" type:"map"` // A list of strings to provide custom labels for SELinux and AppArmor multi-level // security systems. This parameter maps to SecurityOpt in the Create a container // (https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/reference/api/docker_remote_api_v1.19/) // and the --security-opt option to docker run (https://docs.docker.com/reference/commandline/run/). // // The Amazon ECS container agent running on a container instance must register // with the ECS_SELINUX_CAPABLE=true or ECS_APPARMOR_CAPABLE=true environment // variables before containers placed on that instance can use these security // options. For more information, see Amazon ECS Container Agent Configuration // (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/developerguide/ecs-agent-config.html) // in the Amazon EC2 Container Service Developer Guide. DockerSecurityOptions []*string `locationName:"dockerSecurityOptions" type:"list"` // Early versions of the Amazon ECS container agent do not properly handle entryPoint // parameters. If you have problems using entryPoint, update your container // agent or enter your commands and arguments as command array items instead. // // The entry point that is passed to the container. This parameter maps to // Entrypoint in the Create a container (https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/reference/api/docker_remote_api_v1.19/) // and the --entrypoint option to docker run (https://docs.docker.com/reference/commandline/run/). // For more information, see https://docs.docker.com/reference/builder/#entrypoint // (https://docs.docker.com/reference/builder/#entrypoint). EntryPoint []*string `locationName:"entryPoint" type:"list"` // The environment variables to pass to a container. This parameter maps to // Env in the Create a container (https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/reference/api/docker_remote_api_v1.19/) // and the --env option to docker run (https://docs.docker.com/reference/commandline/run/). // // We do not recommend using plain text environment variables for sensitive // information, such as credential data. Environment []*KeyValuePair `locationName:"environment" type:"list"` // If the essential parameter of a container is marked as true, the failure // of that container stops the task. If the essential parameter of a container // is marked as false, then its failure does not affect the rest of the containers // in a task. If this parameter is omitted, a container is assumed to be essential. // // All tasks must have at least one essential container. Essential *bool `locationName:"essential" type:"boolean"` // A list of hostnames and IP address mappings to append to the /etc/hosts file // on the container. This parameter maps to ExtraHosts in the Create a container // (https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/reference/api/docker_remote_api_v1.19/) // and the --add-host option to docker run (https://docs.docker.com/reference/commandline/run/). ExtraHosts []*HostEntry `locationName:"extraHosts" type:"list"` // The hostname to use for your container. This parameter maps to Hostname in // the Create a container (https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/reference/api/docker_remote_api_v1.19/) // and the --hostname option to docker run (https://docs.docker.com/reference/commandline/run/). Hostname *string `locationName:"hostname" type:"string"` // The image used to start a container. This string is passed directly to the // Docker daemon. Images in the Docker Hub registry are available by default. // Other repositories are specified with repository-url/image:tag. Up to 255 // letters (uppercase and lowercase), numbers, hyphens, underscores, colons, // periods, forward slashes, and number signs are allowed. This parameter maps // to Image in the Create a container (https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/reference/api/docker_remote_api_v1.19/) // and the IMAGE parameter of docker run (https://docs.docker.com/reference/commandline/run/). // // Images in official repositories on Docker Hub use a single name (for example, // ubuntu or mongo). Images in other repositories on Docker Hub are qualified // with an organization name (for example, amazon/amazon-ecs-agent). Images // in other online repositories are qualified further by a domain name (for // example, quay.io/assemblyline/ubuntu). Image *string `locationName:"image" type:"string"` // The link parameter allows containers to communicate with each other without // the need for port mappings, using the name parameter and optionally, an alias // for the link. This construct is analogous to name:alias in Docker links. // Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores // are allowed for each name and alias. For more information on linking Docker // containers, see https://docs.docker.com/userguide/dockerlinks/ (https://docs.docker.com/userguide/dockerlinks/). // This parameter maps to Links in the Create a container (https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/reference/api/docker_remote_api_v1.19/) // and the --link option to docker run (https://docs.docker.com/reference/commandline/run/). // // Containers that are collocated on a single container instance may be able // to communicate with each other without requiring links or host port mappings. // Network isolation is achieved on the container instance using security groups // and VPC settings. Links []*string `locationName:"links" type:"list"` // The log configuration specification for the container. This parameter maps // to LogConfig in the Create a container (https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/reference/api/docker_remote_api_v1.19/) // and the --log-driver option to docker run (https://docs.docker.com/reference/commandline/run/). // Valid log drivers are displayed in the LogConfiguration data type. This parameter // requires version 1.18 of the Docker Remote API or greater on your container // instance. To check the Docker Remote API version on your container instance, // log into your container instance and run the following command: sudo docker // version | grep "Server API version" // // The Amazon ECS container agent running on a container instance must register // the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS // environment variable before containers placed on that instance can use these // log configuration options. For more information, see Amazon ECS Container // Agent Configuration (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/developerguide/ecs-agent-config.html) // in the Amazon EC2 Container Service Developer Guide. LogConfiguration *LogConfiguration `locationName:"logConfiguration" type:"structure"` // The number of MiB of memory to reserve for the container. You must specify // a non-zero integer for this parameter; the Docker daemon reserves a minimum // of 4 MiB of memory for a container, so you should not specify fewer than // 4 MiB of memory for your containers. If your container attempts to exceed // the memory allocated here, the container is killed. This parameter maps to // Memory in the Create a container (https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/reference/api/docker_remote_api_v1.19/) // and the --memory option to docker run (https://docs.docker.com/reference/commandline/run/). Memory *int64 `locationName:"memory" type:"integer"` // The mount points for data volumes in your container. This parameter maps // to Volumes in the Create a container (https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/reference/api/docker_remote_api_v1.19/) // and the --volume option to docker run (https://docs.docker.com/reference/commandline/run/). MountPoints []*MountPoint `locationName:"mountPoints" type:"list"` // The name of a container. If you are linking multiple containers together // in a task definition, the name of one container can be entered in the links // of another container to connect the containers. Up to 255 letters (uppercase // and lowercase), numbers, hyphens, and underscores are allowed. This parameter // maps to name in the Create a container (https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/reference/api/docker_remote_api_v1.19/) // and the --name option to docker run (https://docs.docker.com/reference/commandline/run/). Name *string `locationName:"name" type:"string"` // The list of port mappings for the container. Port mappings allow containers // to access ports on the host container instance to send or receive traffic. // This parameter maps to PortBindings in the Create a container (https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/reference/api/docker_remote_api_v1.19/) // and the --publish option to docker run (https://docs.docker.com/reference/commandline/run/). // // After a task reaches the RUNNING status, manual and automatic host and // container port assignments are visible in the Network Bindings section of // a container description of a selected task in the Amazon ECS console, or // the networkBindings section DescribeTasks responses. PortMappings []*PortMapping `locationName:"portMappings" type:"list"` // When this parameter is true, the container is given elevated privileges on // the host container instance (similar to the root user). This parameter maps // to Privileged in the Create a container (https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/reference/api/docker_remote_api_v1.19/) // and the --privileged option to docker run (https://docs.docker.com/reference/commandline/run/). Privileged *bool `locationName:"privileged" type:"boolean"` // When this parameter is true, the container is given read-only access to its // root file system. This parameter maps to ReadonlyRootfs in the Create a container // (https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/reference/api/docker_remote_api_v1.19/) // and the --read-only option to docker run. ReadonlyRootFilesystem *bool `locationName:"readonlyRootFilesystem" type:"boolean"` // A list of ulimits to set in the container. This parameter maps to Ulimits // in the Create a container (https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/reference/api/docker_remote_api_v1.19/) // and the --ulimit option to docker run (https://docs.docker.com/reference/commandline/run/). // Valid naming values are displayed in the Ulimit data type. This parameter // requires version 1.18 of the Docker Remote API or greater on your container // instance. To check the Docker Remote API version on your container instance, // log into your container instance and run the following command: sudo docker // version | grep "Server API version" Ulimits []*Ulimit `locationName:"ulimits" type:"list"` // The user name to use inside the container. This parameter maps to User in // the Create a container (https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/reference/api/docker_remote_api_v1.19/) // and the --user option to docker run (https://docs.docker.com/reference/commandline/run/). User *string `locationName:"user" type:"string"` // Data volumes to mount from another container. This parameter maps to VolumesFrom // in the Create a container (https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/reference/api/docker_remote_api_v1.19/) // and the --volumes-from option to docker run (https://docs.docker.com/reference/commandline/run/). VolumesFrom []*VolumeFrom `locationName:"volumesFrom" type:"list"` // The working directory in which to run commands inside the container. This // parameter maps to WorkingDir in the Create a container (https://docs.docker.com/reference/api/docker_remote_api_v1.19/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/reference/api/docker_remote_api_v1.19/) // and the --workdir option to docker run (https://docs.docker.com/reference/commandline/run/). WorkingDirectory *string `locationName:"workingDirectory" type:"string"` // contains filtered or unexported fields }
Container definitions are used in task definitions to describe the different containers that are launched as part of a task.
func (ContainerDefinition) GoString ¶
func (s ContainerDefinition) GoString() string
GoString returns the string representation
func (ContainerDefinition) String ¶
func (s ContainerDefinition) String() string
String returns the string representation
func (*ContainerDefinition) Validate ¶
func (s *ContainerDefinition) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ContainerInstance ¶
type ContainerInstance struct { // This parameter returns true if the agent is actually connected to Amazon // ECS. Registered instances with an agent that may be unhealthy or stopped // return false, and instances without a connected agent cannot accept placement // requests. AgentConnected *bool `locationName:"agentConnected" type:"boolean"` // The status of the most recent agent update. If an update has never been requested, // this value is NULL. AgentUpdateStatus *string `locationName:"agentUpdateStatus" type:"string" enum:"AgentUpdateStatus"` // The attributes set for the container instance by the Amazon ECS container // agent at instance registration. Attributes []*Attribute `locationName:"attributes" type:"list"` // The Amazon Resource Name (ARN) of the container instance. The ARN contains // the arn:aws:ecs namespace, followed by the region of the container instance, // the AWS account ID of the container instance owner, the container-instance // namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID. ContainerInstanceArn *string `locationName:"containerInstanceArn" type:"string"` // The EC2 instance ID of the container instance. Ec2InstanceId *string `locationName:"ec2InstanceId" type:"string"` // The number of tasks on the container instance that are in the PENDING status. PendingTasksCount *int64 `locationName:"pendingTasksCount" type:"integer"` // The registered resources on the container instance that are in use by current // tasks. RegisteredResources []*Resource `locationName:"registeredResources" type:"list"` // The remaining resources of the container instance that are available for // new tasks. RemainingResources []*Resource `locationName:"remainingResources" type:"list"` // The number of tasks on the container instance that are in the RUNNING status. RunningTasksCount *int64 `locationName:"runningTasksCount" type:"integer"` // The status of the container instance. The valid values are ACTIVE or INACTIVE. // ACTIVE indicates that the container instance can accept tasks. Status *string `locationName:"status" type:"string"` // The version information for the Amazon ECS container agent and Docker daemon // running on the container instance. VersionInfo *VersionInfo `locationName:"versionInfo" type:"structure"` // contains filtered or unexported fields }
An EC2 instance that is running the Amazon ECS agent and has been registered with a cluster.
func (ContainerInstance) GoString ¶
func (s ContainerInstance) GoString() string
GoString returns the string representation
func (ContainerInstance) String ¶
func (s ContainerInstance) String() string
String returns the string representation
type ContainerOverride ¶
type ContainerOverride struct { // The command to send to the container that overrides the default command from // the Docker image or the task definition. Command []*string `locationName:"command" type:"list"` // The environment variables to send to the container. You can add new environment // variables, which are added to the container at launch, or you can override // the existing environment variables from the Docker image or the task definition. Environment []*KeyValuePair `locationName:"environment" type:"list"` // The name of the container that receives the override. Name *string `locationName:"name" type:"string"` // contains filtered or unexported fields }
The overrides that should be sent to a container.
func (ContainerOverride) GoString ¶
func (s ContainerOverride) GoString() string
GoString returns the string representation
func (ContainerOverride) String ¶
func (s ContainerOverride) String() string
String returns the string representation
type CreateClusterInput ¶
type CreateClusterInput struct { // The name of your cluster. If you do not specify a name for your cluster, // you create a cluster named default. Up to 255 letters (uppercase and lowercase), // numbers, hyphens, and underscores are allowed. ClusterName *string `locationName:"clusterName" type:"string"` // contains filtered or unexported fields }
func (CreateClusterInput) GoString ¶
func (s CreateClusterInput) GoString() string
GoString returns the string representation
func (CreateClusterInput) String ¶
func (s CreateClusterInput) String() string
String returns the string representation
type CreateClusterOutput ¶
type CreateClusterOutput struct { // The full description of your new cluster. Cluster *Cluster `locationName:"cluster" type:"structure"` // contains filtered or unexported fields }
func (CreateClusterOutput) GoString ¶
func (s CreateClusterOutput) GoString() string
GoString returns the string representation
func (CreateClusterOutput) String ¶
func (s CreateClusterOutput) String() string
String returns the string representation
type CreateServiceInput ¶
type CreateServiceInput struct { // Unique, case-sensitive identifier you provide to ensure the idempotency of // the request. Up to 32 ASCII characters are allowed. ClientToken *string `locationName:"clientToken" type:"string"` // The short name or full Amazon Resource Name (ARN) of the cluster on which // to run your service. If you do not specify a cluster, the default cluster // is assumed. Cluster *string `locationName:"cluster" type:"string"` // Optional deployment parameters that control how many tasks run during the // deployment and the ordering of stopping and starting tasks. DeploymentConfiguration *DeploymentConfiguration `locationName:"deploymentConfiguration" type:"structure"` // The number of instantiations of the specified task definition to place and // keep running on your cluster. DesiredCount *int64 `locationName:"desiredCount" type:"integer" required:"true"` // A list of load balancer objects, containing the load balancer name, the container // name (as it appears in a container definition), and the container port to // access from the load balancer. LoadBalancers []*LoadBalancer `locationName:"loadBalancers" type:"list"` // The name or full Amazon Resource Name (ARN) of the IAM role that allows your // Amazon ECS container agent to make calls to your load balancer on your behalf. // This parameter is only required if you are using a load balancer with your // service. Role *string `locationName:"role" type:"string"` // The name of your service. Up to 255 letters (uppercase and lowercase), numbers, // hyphens, and underscores are allowed. Service names must be unique within // a cluster, but you can have similarly named services in multiple clusters // within a region or across multiple regions. ServiceName *string `locationName:"serviceName" type:"string" required:"true"` // The family and revision (family:revision) or full Amazon Resource Name (ARN) // of the task definition to run in your service. If a revision is not specified, // the latest ACTIVE revision is used. TaskDefinition *string `locationName:"taskDefinition" type:"string" required:"true"` // contains filtered or unexported fields }
func (CreateServiceInput) GoString ¶
func (s CreateServiceInput) GoString() string
GoString returns the string representation
func (CreateServiceInput) String ¶
func (s CreateServiceInput) String() string
String returns the string representation
func (*CreateServiceInput) Validate ¶
func (s *CreateServiceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateServiceOutput ¶
type CreateServiceOutput struct { // The full description of your service following the create call. Service *Service `locationName:"service" type:"structure"` // contains filtered or unexported fields }
func (CreateServiceOutput) GoString ¶
func (s CreateServiceOutput) GoString() string
GoString returns the string representation
func (CreateServiceOutput) String ¶
func (s CreateServiceOutput) String() string
String returns the string representation
type DeleteClusterInput ¶
type DeleteClusterInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster to delete. Cluster *string `locationName:"cluster" type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteClusterInput) GoString ¶
func (s DeleteClusterInput) GoString() string
GoString returns the string representation
func (DeleteClusterInput) String ¶
func (s DeleteClusterInput) String() string
String returns the string representation
func (*DeleteClusterInput) Validate ¶
func (s *DeleteClusterInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteClusterOutput ¶
type DeleteClusterOutput struct { // The full description of the deleted cluster. Cluster *Cluster `locationName:"cluster" type:"structure"` // contains filtered or unexported fields }
func (DeleteClusterOutput) GoString ¶
func (s DeleteClusterOutput) GoString() string
GoString returns the string representation
func (DeleteClusterOutput) String ¶
func (s DeleteClusterOutput) String() string
String returns the string representation
type DeleteServiceInput ¶
type DeleteServiceInput struct { // The name of the cluster that hosts the service to delete. If you do not specify // a cluster, the default cluster is assumed. Cluster *string `locationName:"cluster" type:"string"` // The name of the service to delete. Service *string `locationName:"service" type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteServiceInput) GoString ¶
func (s DeleteServiceInput) GoString() string
GoString returns the string representation
func (DeleteServiceInput) String ¶
func (s DeleteServiceInput) String() string
String returns the string representation
func (*DeleteServiceInput) Validate ¶
func (s *DeleteServiceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteServiceOutput ¶
type DeleteServiceOutput struct { // The full description of the deleted service. Service *Service `locationName:"service" type:"structure"` // contains filtered or unexported fields }
func (DeleteServiceOutput) GoString ¶
func (s DeleteServiceOutput) GoString() string
GoString returns the string representation
func (DeleteServiceOutput) String ¶
func (s DeleteServiceOutput) String() string
String returns the string representation
type Deployment ¶
type Deployment struct { // The Unix time in seconds and milliseconds when the service was created. CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"unix"` // The most recent desired count of tasks that was specified for the service // to deploy or maintain. DesiredCount *int64 `locationName:"desiredCount" type:"integer"` // The ID of the deployment. Id *string `locationName:"id" type:"string"` // The number of tasks in the deployment that are in the PENDING status. PendingCount *int64 `locationName:"pendingCount" type:"integer"` // The number of tasks in the deployment that are in the RUNNING status. RunningCount *int64 `locationName:"runningCount" type:"integer"` // The status of the deployment. Valid values are PRIMARY (for the most recent // deployment), ACTIVE (for previous deployments that still have tasks running, // but are being replaced with the PRIMARY deployment), and INACTIVE (for deployments // that have been completely replaced). Status *string `locationName:"status" type:"string"` // The most recent task definition that was specified for the service to use. TaskDefinition *string `locationName:"taskDefinition" type:"string"` // The Unix time in seconds and milliseconds when the service was last updated. UpdatedAt *time.Time `locationName:"updatedAt" type:"timestamp" timestampFormat:"unix"` // contains filtered or unexported fields }
The details of an Amazon ECS service deployment.
func (Deployment) GoString ¶
func (s Deployment) GoString() string
GoString returns the string representation
func (Deployment) String ¶
func (s Deployment) String() string
String returns the string representation
type DeploymentConfiguration ¶
type DeploymentConfiguration struct { // The upper limit (as a percentage of the service's desiredCount) of the number // of running tasks that can be running in a service during a deployment. The // maximum number of tasks during a deployment is the desiredCount multiplied // by the maximumPercent/100, rounded down to the nearest integer value. MaximumPercent *int64 `locationName:"maximumPercent" type:"integer"` // The lower limit (as a percentage of the service's desiredCount) of the number // of running tasks that must remain running and healthy in a service during // a deployment. The minimum healthy tasks during a deployment is the desiredCount // multiplied by the minimumHealthyPercent/100, rounded up to the nearest integer // value. MinimumHealthyPercent *int64 `locationName:"minimumHealthyPercent" type:"integer"` // contains filtered or unexported fields }
Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
func (DeploymentConfiguration) GoString ¶
func (s DeploymentConfiguration) GoString() string
GoString returns the string representation
func (DeploymentConfiguration) String ¶
func (s DeploymentConfiguration) String() string
String returns the string representation
type DeregisterContainerInstanceInput ¶
type DeregisterContainerInstanceInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster that hosts // the container instance to deregister. If you do not specify a cluster, the // default cluster is assumed. Cluster *string `locationName:"cluster" type:"string"` // The container instance ID or full Amazon Resource Name (ARN) of the container // instance to deregister. The ARN contains the arn:aws:ecs namespace, followed // by the region of the container instance, the AWS account ID of the container // instance owner, the container-instance namespace, and then the container // instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID. ContainerInstance *string `locationName:"containerInstance" type:"string" required:"true"` // Forces the deregistration of the container instance. If you have tasks running // on the container instance when you deregister it with the force option, these // tasks remain running and they continue to pass Elastic Load Balancing load // balancer health checks until you terminate the instance or the tasks stop // through some other means, but they are orphaned (no longer monitored or accounted // for by Amazon ECS). If an orphaned task on your container instance is part // of an Amazon ECS service, then the service scheduler starts another copy // of that task, on a different container instance if possible. Force *bool `locationName:"force" type:"boolean"` // contains filtered or unexported fields }
func (DeregisterContainerInstanceInput) GoString ¶
func (s DeregisterContainerInstanceInput) GoString() string
GoString returns the string representation
func (DeregisterContainerInstanceInput) String ¶
func (s DeregisterContainerInstanceInput) String() string
String returns the string representation
func (*DeregisterContainerInstanceInput) Validate ¶
func (s *DeregisterContainerInstanceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeregisterContainerInstanceOutput ¶
type DeregisterContainerInstanceOutput struct { // An EC2 instance that is running the Amazon ECS agent and has been registered // with a cluster. ContainerInstance *ContainerInstance `locationName:"containerInstance" type:"structure"` // contains filtered or unexported fields }
func (DeregisterContainerInstanceOutput) GoString ¶
func (s DeregisterContainerInstanceOutput) GoString() string
GoString returns the string representation
func (DeregisterContainerInstanceOutput) String ¶
func (s DeregisterContainerInstanceOutput) String() string
String returns the string representation
type DeregisterTaskDefinitionInput ¶
type DeregisterTaskDefinitionInput struct { // The family and revision (family:revision) or full Amazon Resource Name (ARN) // of the task definition to deregister. You must specify a revision. TaskDefinition *string `locationName:"taskDefinition" type:"string" required:"true"` // contains filtered or unexported fields }
func (DeregisterTaskDefinitionInput) GoString ¶
func (s DeregisterTaskDefinitionInput) GoString() string
GoString returns the string representation
func (DeregisterTaskDefinitionInput) String ¶
func (s DeregisterTaskDefinitionInput) String() string
String returns the string representation
func (*DeregisterTaskDefinitionInput) Validate ¶
func (s *DeregisterTaskDefinitionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeregisterTaskDefinitionOutput ¶
type DeregisterTaskDefinitionOutput struct { // The full description of the deregistered task. TaskDefinition *TaskDefinition `locationName:"taskDefinition" type:"structure"` // contains filtered or unexported fields }
func (DeregisterTaskDefinitionOutput) GoString ¶
func (s DeregisterTaskDefinitionOutput) GoString() string
GoString returns the string representation
func (DeregisterTaskDefinitionOutput) String ¶
func (s DeregisterTaskDefinitionOutput) String() string
String returns the string representation
type DescribeClustersInput ¶
type DescribeClustersInput struct { // A space-separated list of cluster names or full cluster Amazon Resource Name // (ARN) entries. If you do not specify a cluster, the default cluster is assumed. Clusters []*string `locationName:"clusters" type:"list"` // contains filtered or unexported fields }
func (DescribeClustersInput) GoString ¶
func (s DescribeClustersInput) GoString() string
GoString returns the string representation
func (DescribeClustersInput) String ¶
func (s DescribeClustersInput) String() string
String returns the string representation
type DescribeClustersOutput ¶
type DescribeClustersOutput struct { // The list of clusters. Clusters []*Cluster `locationName:"clusters" type:"list"` // Any failures associated with the call. Failures []*Failure `locationName:"failures" type:"list"` // contains filtered or unexported fields }
func (DescribeClustersOutput) GoString ¶
func (s DescribeClustersOutput) GoString() string
GoString returns the string representation
func (DescribeClustersOutput) String ¶
func (s DescribeClustersOutput) String() string
String returns the string representation
type DescribeContainerInstancesInput ¶
type DescribeContainerInstancesInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster that hosts // the container instances to describe. If you do not specify a cluster, the // default cluster is assumed. Cluster *string `locationName:"cluster" type:"string"` // A space-separated list of container instance IDs or full Amazon Resource // Name (ARN) entries. ContainerInstances []*string `locationName:"containerInstances" type:"list" required:"true"` // contains filtered or unexported fields }
func (DescribeContainerInstancesInput) GoString ¶
func (s DescribeContainerInstancesInput) GoString() string
GoString returns the string representation
func (DescribeContainerInstancesInput) String ¶
func (s DescribeContainerInstancesInput) String() string
String returns the string representation
func (*DescribeContainerInstancesInput) Validate ¶
func (s *DescribeContainerInstancesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeContainerInstancesOutput ¶
type DescribeContainerInstancesOutput struct { // The list of container instances. ContainerInstances []*ContainerInstance `locationName:"containerInstances" type:"list"` // Any failures associated with the call. Failures []*Failure `locationName:"failures" type:"list"` // contains filtered or unexported fields }
func (DescribeContainerInstancesOutput) GoString ¶
func (s DescribeContainerInstancesOutput) GoString() string
GoString returns the string representation
func (DescribeContainerInstancesOutput) String ¶
func (s DescribeContainerInstancesOutput) String() string
String returns the string representation
type DescribeServicesInput ¶
type DescribeServicesInput struct { // The name of the cluster that hosts the service to describe. If you do not // specify a cluster, the default cluster is assumed. Cluster *string `locationName:"cluster" type:"string"` // A list of services to describe. Services []*string `locationName:"services" type:"list" required:"true"` // contains filtered or unexported fields }
func (DescribeServicesInput) GoString ¶
func (s DescribeServicesInput) GoString() string
GoString returns the string representation
func (DescribeServicesInput) String ¶
func (s DescribeServicesInput) String() string
String returns the string representation
func (*DescribeServicesInput) Validate ¶
func (s *DescribeServicesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeServicesOutput ¶
type DescribeServicesOutput struct { // Any failures associated with the call. Failures []*Failure `locationName:"failures" type:"list"` // The list of services described. Services []*Service `locationName:"services" type:"list"` // contains filtered or unexported fields }
func (DescribeServicesOutput) GoString ¶
func (s DescribeServicesOutput) GoString() string
GoString returns the string representation
func (DescribeServicesOutput) String ¶
func (s DescribeServicesOutput) String() string
String returns the string representation
type DescribeTaskDefinitionInput ¶
type DescribeTaskDefinitionInput struct { // The family for the latest ACTIVE revision, family and revision (family:revision) // for a specific revision in the family, or full Amazon Resource Name (ARN) // of the task definition to describe. TaskDefinition *string `locationName:"taskDefinition" type:"string" required:"true"` // contains filtered or unexported fields }
func (DescribeTaskDefinitionInput) GoString ¶
func (s DescribeTaskDefinitionInput) GoString() string
GoString returns the string representation
func (DescribeTaskDefinitionInput) String ¶
func (s DescribeTaskDefinitionInput) String() string
String returns the string representation
func (*DescribeTaskDefinitionInput) Validate ¶
func (s *DescribeTaskDefinitionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeTaskDefinitionOutput ¶
type DescribeTaskDefinitionOutput struct { // The full task definition description. TaskDefinition *TaskDefinition `locationName:"taskDefinition" type:"structure"` // contains filtered or unexported fields }
func (DescribeTaskDefinitionOutput) GoString ¶
func (s DescribeTaskDefinitionOutput) GoString() string
GoString returns the string representation
func (DescribeTaskDefinitionOutput) String ¶
func (s DescribeTaskDefinitionOutput) String() string
String returns the string representation
type DescribeTasksInput ¶
type DescribeTasksInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster that hosts // the task to describe. If you do not specify a cluster, the default cluster // is assumed. Cluster *string `locationName:"cluster" type:"string"` // A space-separated list of task IDs or full Amazon Resource Name (ARN) entries. Tasks []*string `locationName:"tasks" type:"list" required:"true"` // contains filtered or unexported fields }
func (DescribeTasksInput) GoString ¶
func (s DescribeTasksInput) GoString() string
GoString returns the string representation
func (DescribeTasksInput) String ¶
func (s DescribeTasksInput) String() string
String returns the string representation
func (*DescribeTasksInput) Validate ¶
func (s *DescribeTasksInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeTasksOutput ¶
type DescribeTasksOutput struct { // Any failures associated with the call. Failures []*Failure `locationName:"failures" type:"list"` // The list of tasks. Tasks []*Task `locationName:"tasks" type:"list"` // contains filtered or unexported fields }
func (DescribeTasksOutput) GoString ¶
func (s DescribeTasksOutput) GoString() string
GoString returns the string representation
func (DescribeTasksOutput) String ¶
func (s DescribeTasksOutput) String() string
String returns the string representation
type DiscoverPollEndpointInput ¶
type DiscoverPollEndpointInput struct { // The cluster that the container instance belongs to. Cluster *string `locationName:"cluster" type:"string"` // The container instance ID or full Amazon Resource Name (ARN) of the container // instance. The ARN contains the arn:aws:ecs namespace, followed by the region // of the container instance, the AWS account ID of the container instance owner, // the container-instance namespace, and then the container instance ID. For // example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID. ContainerInstance *string `locationName:"containerInstance" type:"string"` // contains filtered or unexported fields }
func (DiscoverPollEndpointInput) GoString ¶
func (s DiscoverPollEndpointInput) GoString() string
GoString returns the string representation
func (DiscoverPollEndpointInput) String ¶
func (s DiscoverPollEndpointInput) String() string
String returns the string representation
type DiscoverPollEndpointOutput ¶
type DiscoverPollEndpointOutput struct { // The endpoint for the Amazon ECS agent to poll. Endpoint *string `locationName:"endpoint" type:"string"` // The telemetry endpoint for the Amazon ECS agent. TelemetryEndpoint *string `locationName:"telemetryEndpoint" type:"string"` // contains filtered or unexported fields }
func (DiscoverPollEndpointOutput) GoString ¶
func (s DiscoverPollEndpointOutput) GoString() string
GoString returns the string representation
func (DiscoverPollEndpointOutput) String ¶
func (s DiscoverPollEndpointOutput) String() string
String returns the string representation
type ECS ¶
Amazon EC2 Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster of EC2 instances. Amazon ECS lets you launch and stop container-enabled applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features like security groups, Amazon EBS volumes, and IAM roles.
You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon EC2 Container Service eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure. The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client's properties though.
func New ¶
func New(p client.ConfigProvider, cfgs ...*aws.Config) *ECS
New creates a new instance of the ECS client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
// Create a ECS client from just a session. svc := ecs.New(mySession) // Create a ECS client with additional configuration svc := ecs.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (*ECS) CreateCluster ¶
func (c *ECS) CreateCluster(input *CreateClusterInput) (*CreateClusterOutput, error)
Creates a new Amazon ECS cluster. By default, your account receives a default cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster action.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(session.New()) params := &ecs.CreateClusterInput{ ClusterName: aws.String("String"), } resp, err := svc.CreateCluster(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ECS) CreateClusterRequest ¶
func (c *ECS) CreateClusterRequest(input *CreateClusterInput) (req *request.Request, output *CreateClusterOutput)
CreateClusterRequest generates a request for the CreateCluster operation.
func (*ECS) CreateService ¶
func (c *ECS) CreateService(input *CreateServiceInput) (*CreateServiceOutput, error)
Runs and maintains a desired number of tasks from a specified task definition. If the number of tasks running in a service drops below desiredCount, Amazon ECS spawns another instantiation of the task in the specified cluster. To update an existing service, see UpdateService.
You can optionally specify a deployment configuration for your service. During a deployment (which is triggered by changing the task definition of a service with an UpdateService operation), the service scheduler uses the minimumHealthyPercent and maximumPercent parameters to determine the deployment strategy.
If the minimumHealthyPercent is below 100%, the scheduler can ignore the desiredCount temporarily during a deployment. For example, if your service has a desiredCount of four tasks, a minimumHealthyPercent of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and the container instance it is hosted on is reported as healthy by the load balancer. The default value for minimumHealthyPercent is 50% in the console and 100% for the AWS CLI, the AWS SDKs, and the APIs.
The maximumPercent parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if your service has a desiredCount of four tasks, a maximumPercent value of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default value for maximumPercent is 200%.
When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones in your cluster with the following logic:
Determine which of the container instances in your cluster can support
your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).
Sort the valid container instances by the fewest number of running tasks
for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.
Place the new service task on a valid container instance in an optimal
Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(session.New()) params := &ecs.CreateServiceInput{ DesiredCount: aws.Int64(1), // Required ServiceName: aws.String("String"), // Required TaskDefinition: aws.String("String"), // Required ClientToken: aws.String("String"), Cluster: aws.String("String"), DeploymentConfiguration: &ecs.DeploymentConfiguration{ MaximumPercent: aws.Int64(1), MinimumHealthyPercent: aws.Int64(1), }, LoadBalancers: []*ecs.LoadBalancer{ { // Required ContainerName: aws.String("String"), ContainerPort: aws.Int64(1), LoadBalancerName: aws.String("String"), }, // More values... }, Role: aws.String("String"), } resp, err := svc.CreateService(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ECS) CreateServiceRequest ¶
func (c *ECS) CreateServiceRequest(input *CreateServiceInput) (req *request.Request, output *CreateServiceOutput)
CreateServiceRequest generates a request for the CreateService operation.
func (*ECS) DeleteCluster ¶
func (c *ECS) DeleteCluster(input *DeleteClusterInput) (*DeleteClusterOutput, error)
Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(session.New()) params := &ecs.DeleteClusterInput{ Cluster: aws.String("String"), // Required } resp, err := svc.DeleteCluster(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ECS) DeleteClusterRequest ¶
func (c *ECS) DeleteClusterRequest(input *DeleteClusterInput) (req *request.Request, output *DeleteClusterOutput)
DeleteClusterRequest generates a request for the DeleteCluster operation.
func (*ECS) DeleteService ¶
func (c *ECS) DeleteService(input *DeleteServiceInput) (*DeleteServiceOutput, error)
Deletes a specified service within a cluster. You can delete a service if you have no running tasks in it and the desired task count is zero. If the service is actively maintaining tasks, you cannot delete it, and you must update the service to a desired task count of zero. For more information, see UpdateService.
When you delete a service, if there are still running tasks that require
cleanup, the service status moves from ACTIVE to DRAINING, and the service is no longer visible in the console or in ListServices API operations. After the tasks have stopped, then the service status moves from DRAINING to INACTIVE. Services in the DRAINING or INACTIVE status can still be viewed with DescribeServices API operations; however, in the future, INACTIVE services may be cleaned up and purged from Amazon ECS record keeping, and DescribeServices API operations on those services will return a ServiceNotFoundException error.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(session.New()) params := &ecs.DeleteServiceInput{ Service: aws.String("String"), // Required Cluster: aws.String("String"), } resp, err := svc.DeleteService(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ECS) DeleteServiceRequest ¶
func (c *ECS) DeleteServiceRequest(input *DeleteServiceInput) (req *request.Request, output *DeleteServiceOutput)
DeleteServiceRequest generates a request for the DeleteService operation.
func (*ECS) DeregisterContainerInstance ¶
func (c *ECS) DeregisterContainerInstance(input *DeregisterContainerInstanceInput) (*DeregisterContainerInstanceOutput, error)
Deregisters an Amazon ECS container instance from the specified cluster. This instance is no longer available to run tasks.
If you intend to use the container instance for some other purpose after deregistration, you should stop all of the tasks running on the container instance before deregistration to avoid any orphaned tasks from consuming resources.
Deregistering a container instance removes the instance from a cluster, but it does not terminate the EC2 instance; if you are finished using the instance, be sure to terminate it in the Amazon EC2 console to stop billing.
When you terminate a container instance, it is automatically deregistered from your cluster.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(session.New()) params := &ecs.DeregisterContainerInstanceInput{ ContainerInstance: aws.String("String"), // Required Cluster: aws.String("String"), Force: aws.Bool(true), } resp, err := svc.DeregisterContainerInstance(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ECS) DeregisterContainerInstanceRequest ¶
func (c *ECS) DeregisterContainerInstanceRequest(input *DeregisterContainerInstanceInput) (req *request.Request, output *DeregisterContainerInstanceOutput)
DeregisterContainerInstanceRequest generates a request for the DeregisterContainerInstance operation.
func (*ECS) DeregisterTaskDefinition ¶
func (c *ECS) DeregisterTaskDefinition(input *DeregisterTaskDefinitionInput) (*DeregisterTaskDefinitionOutput, error)
Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE. Existing tasks and services that reference an INACTIVE task definition continue to run without disruption. Existing services that reference an INACTIVE task definition can still scale up or down by modifying the service's desired count.
You cannot use an INACTIVE task definition to run new tasks or create new services, and you cannot update an existing service to reference an INACTIVE task definition (although there may be up to a 10 minute window following deregistration where these restrictions have not yet taken effect).
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(session.New()) params := &ecs.DeregisterTaskDefinitionInput{ TaskDefinition: aws.String("String"), // Required } resp, err := svc.DeregisterTaskDefinition(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ECS) DeregisterTaskDefinitionRequest ¶
func (c *ECS) DeregisterTaskDefinitionRequest(input *DeregisterTaskDefinitionInput) (req *request.Request, output *DeregisterTaskDefinitionOutput)
DeregisterTaskDefinitionRequest generates a request for the DeregisterTaskDefinition operation.
func (*ECS) DescribeClusters ¶
func (c *ECS) DescribeClusters(input *DescribeClustersInput) (*DescribeClustersOutput, error)
Describes one or more of your clusters.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(session.New()) params := &ecs.DescribeClustersInput{ Clusters: []*string{ aws.String("String"), // Required // More values... }, } resp, err := svc.DescribeClusters(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ECS) DescribeClustersRequest ¶
func (c *ECS) DescribeClustersRequest(input *DescribeClustersInput) (req *request.Request, output *DescribeClustersOutput)
DescribeClustersRequest generates a request for the DescribeClusters operation.
func (*ECS) DescribeContainerInstances ¶
func (c *ECS) DescribeContainerInstances(input *DescribeContainerInstancesInput) (*DescribeContainerInstancesOutput, error)
Describes Amazon EC2 Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(session.New()) params := &ecs.DescribeContainerInstancesInput{ ContainerInstances: []*string{ // Required aws.String("String"), // Required // More values... }, Cluster: aws.String("String"), } resp, err := svc.DescribeContainerInstances(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ECS) DescribeContainerInstancesRequest ¶
func (c *ECS) DescribeContainerInstancesRequest(input *DescribeContainerInstancesInput) (req *request.Request, output *DescribeContainerInstancesOutput)
DescribeContainerInstancesRequest generates a request for the DescribeContainerInstances operation.
func (*ECS) DescribeServices ¶
func (c *ECS) DescribeServices(input *DescribeServicesInput) (*DescribeServicesOutput, error)
Describes the specified services running in your cluster.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(session.New()) params := &ecs.DescribeServicesInput{ Services: []*string{ // Required aws.String("String"), // Required // More values... }, Cluster: aws.String("String"), } resp, err := svc.DescribeServices(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ECS) DescribeServicesRequest ¶
func (c *ECS) DescribeServicesRequest(input *DescribeServicesInput) (req *request.Request, output *DescribeServicesOutput)
DescribeServicesRequest generates a request for the DescribeServices operation.
func (*ECS) DescribeTaskDefinition ¶
func (c *ECS) DescribeTaskDefinition(input *DescribeTaskDefinitionInput) (*DescribeTaskDefinitionOutput, error)
Describes a task definition. You can specify a family and revision to find information about a specific task definition, or you can simply specify the family to find the latest ACTIVE revision in that family.
You can only describe INACTIVE task definitions while an active task or
service references them.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(session.New()) params := &ecs.DescribeTaskDefinitionInput{ TaskDefinition: aws.String("String"), // Required } resp, err := svc.DescribeTaskDefinition(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ECS) DescribeTaskDefinitionRequest ¶
func (c *ECS) DescribeTaskDefinitionRequest(input *DescribeTaskDefinitionInput) (req *request.Request, output *DescribeTaskDefinitionOutput)
DescribeTaskDefinitionRequest generates a request for the DescribeTaskDefinition operation.
func (*ECS) DescribeTasks ¶
func (c *ECS) DescribeTasks(input *DescribeTasksInput) (*DescribeTasksOutput, error)
Describes a specified task or tasks.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(session.New()) params := &ecs.DescribeTasksInput{ Tasks: []*string{ // Required aws.String("String"), // Required // More values... }, Cluster: aws.String("String"), } resp, err := svc.DescribeTasks(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ECS) DescribeTasksRequest ¶
func (c *ECS) DescribeTasksRequest(input *DescribeTasksInput) (req *request.Request, output *DescribeTasksOutput)
DescribeTasksRequest generates a request for the DescribeTasks operation.
func (*ECS) DiscoverPollEndpoint ¶
func (c *ECS) DiscoverPollEndpoint(input *DiscoverPollEndpointInput) (*DiscoverPollEndpointOutput, error)
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Returns an endpoint for the Amazon EC2 Container Service agent to poll for updates.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(session.New()) params := &ecs.DiscoverPollEndpointInput{ Cluster: aws.String("String"), ContainerInstance: aws.String("String"), } resp, err := svc.DiscoverPollEndpoint(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ECS) DiscoverPollEndpointRequest ¶
func (c *ECS) DiscoverPollEndpointRequest(input *DiscoverPollEndpointInput) (req *request.Request, output *DiscoverPollEndpointOutput)
DiscoverPollEndpointRequest generates a request for the DiscoverPollEndpoint operation.
func (*ECS) ListClusters ¶
func (c *ECS) ListClusters(input *ListClustersInput) (*ListClustersOutput, error)
Returns a list of existing clusters.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(session.New()) params := &ecs.ListClustersInput{ MaxResults: aws.Int64(1), NextToken: aws.String("String"), } resp, err := svc.ListClusters(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ECS) ListClustersPages ¶
func (c *ECS) ListClustersPages(input *ListClustersInput, fn func(p *ListClustersOutput, lastPage bool) (shouldContinue bool)) error
func (*ECS) ListClustersRequest ¶
func (c *ECS) ListClustersRequest(input *ListClustersInput) (req *request.Request, output *ListClustersOutput)
ListClustersRequest generates a request for the ListClusters operation.
func (*ECS) ListContainerInstances ¶
func (c *ECS) ListContainerInstances(input *ListContainerInstancesInput) (*ListContainerInstancesOutput, error)
Returns a list of container instances in a specified cluster.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(session.New()) params := &ecs.ListContainerInstancesInput{ Cluster: aws.String("String"), MaxResults: aws.Int64(1), NextToken: aws.String("String"), } resp, err := svc.ListContainerInstances(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ECS) ListContainerInstancesPages ¶
func (c *ECS) ListContainerInstancesPages(input *ListContainerInstancesInput, fn func(p *ListContainerInstancesOutput, lastPage bool) (shouldContinue bool)) error
func (*ECS) ListContainerInstancesRequest ¶
func (c *ECS) ListContainerInstancesRequest(input *ListContainerInstancesInput) (req *request.Request, output *ListContainerInstancesOutput)
ListContainerInstancesRequest generates a request for the ListContainerInstances operation.
func (*ECS) ListServices ¶
func (c *ECS) ListServices(input *ListServicesInput) (*ListServicesOutput, error)
Lists the services that are running in a specified cluster.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(session.New()) params := &ecs.ListServicesInput{ Cluster: aws.String("String"), MaxResults: aws.Int64(1), NextToken: aws.String("String"), } resp, err := svc.ListServices(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ECS) ListServicesPages ¶
func (c *ECS) ListServicesPages(input *ListServicesInput, fn func(p *ListServicesOutput, lastPage bool) (shouldContinue bool)) error
func (*ECS) ListServicesRequest ¶
func (c *ECS) ListServicesRequest(input *ListServicesInput) (req *request.Request, output *ListServicesOutput)
ListServicesRequest generates a request for the ListServices operation.
func (*ECS) ListTaskDefinitionFamilies ¶
func (c *ECS) ListTaskDefinitionFamilies(input *ListTaskDefinitionFamiliesInput) (*ListTaskDefinitionFamiliesOutput, error)
Returns a list of task definition families that are registered to your account (which may include task definition families that no longer have any ACTIVE task definitions). You can filter the results with the familyPrefix parameter.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(session.New()) params := &ecs.ListTaskDefinitionFamiliesInput{ FamilyPrefix: aws.String("String"), MaxResults: aws.Int64(1), NextToken: aws.String("String"), } resp, err := svc.ListTaskDefinitionFamilies(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ECS) ListTaskDefinitionFamiliesPages ¶
func (c *ECS) ListTaskDefinitionFamiliesPages(input *ListTaskDefinitionFamiliesInput, fn func(p *ListTaskDefinitionFamiliesOutput, lastPage bool) (shouldContinue bool)) error
func (*ECS) ListTaskDefinitionFamiliesRequest ¶
func (c *ECS) ListTaskDefinitionFamiliesRequest(input *ListTaskDefinitionFamiliesInput) (req *request.Request, output *ListTaskDefinitionFamiliesOutput)
ListTaskDefinitionFamiliesRequest generates a request for the ListTaskDefinitionFamilies operation.
func (*ECS) ListTaskDefinitions ¶
func (c *ECS) ListTaskDefinitions(input *ListTaskDefinitionsInput) (*ListTaskDefinitionsOutput, error)
Returns a list of task definitions that are registered to your account. You can filter the results by family name with the familyPrefix parameter or by status with the status parameter.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(session.New()) params := &ecs.ListTaskDefinitionsInput{ FamilyPrefix: aws.String("String"), MaxResults: aws.Int64(1), NextToken: aws.String("String"), Sort: aws.String("SortOrder"), Status: aws.String("TaskDefinitionStatus"), } resp, err := svc.ListTaskDefinitions(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ECS) ListTaskDefinitionsPages ¶
func (c *ECS) ListTaskDefinitionsPages(input *ListTaskDefinitionsInput, fn func(p *ListTaskDefinitionsOutput, lastPage bool) (shouldContinue bool)) error
func (*ECS) ListTaskDefinitionsRequest ¶
func (c *ECS) ListTaskDefinitionsRequest(input *ListTaskDefinitionsInput) (req *request.Request, output *ListTaskDefinitionsOutput)
ListTaskDefinitionsRequest generates a request for the ListTaskDefinitions operation.
func (*ECS) ListTasks ¶
func (c *ECS) ListTasks(input *ListTasksInput) (*ListTasksOutput, error)
Returns a list of tasks for a specified cluster. You can filter the results by family name, by a particular container instance, or by the desired status of the task with the family, containerInstance, and desiredStatus parameters.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(session.New()) params := &ecs.ListTasksInput{ Cluster: aws.String("String"), ContainerInstance: aws.String("String"), DesiredStatus: aws.String("DesiredStatus"), Family: aws.String("String"), MaxResults: aws.Int64(1), NextToken: aws.String("String"), ServiceName: aws.String("String"), StartedBy: aws.String("String"), } resp, err := svc.ListTasks(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ECS) ListTasksPages ¶
func (c *ECS) ListTasksPages(input *ListTasksInput, fn func(p *ListTasksOutput, lastPage bool) (shouldContinue bool)) error
func (*ECS) ListTasksRequest ¶
func (c *ECS) ListTasksRequest(input *ListTasksInput) (req *request.Request, output *ListTasksOutput)
ListTasksRequest generates a request for the ListTasks operation.
func (*ECS) RegisterContainerInstance ¶
func (c *ECS) RegisterContainerInstance(input *RegisterContainerInstanceInput) (*RegisterContainerInstanceOutput, error)
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Registers an EC2 instance into the specified cluster. This instance becomes available to place containers on.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(session.New()) params := &ecs.RegisterContainerInstanceInput{ Attributes: []*ecs.Attribute{ { // Required Name: aws.String("String"), // Required Value: aws.String("String"), }, // More values... }, Cluster: aws.String("String"), ContainerInstanceArn: aws.String("String"), InstanceIdentityDocument: aws.String("String"), InstanceIdentityDocumentSignature: aws.String("String"), TotalResources: []*ecs.Resource{ { // Required DoubleValue: aws.Float64(1.0), IntegerValue: aws.Int64(1), LongValue: aws.Int64(1), Name: aws.String("String"), StringSetValue: []*string{ aws.String("String"), // Required // More values... }, Type: aws.String("String"), }, // More values... }, VersionInfo: &ecs.VersionInfo{ AgentHash: aws.String("String"), AgentVersion: aws.String("String"), DockerVersion: aws.String("String"), }, } resp, err := svc.RegisterContainerInstance(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ECS) RegisterContainerInstanceRequest ¶
func (c *ECS) RegisterContainerInstanceRequest(input *RegisterContainerInstanceInput) (req *request.Request, output *RegisterContainerInstanceOutput)
RegisterContainerInstanceRequest generates a request for the RegisterContainerInstance operation.
func (*ECS) RegisterTaskDefinition ¶
func (c *ECS) RegisterTaskDefinition(input *RegisterTaskDefinitionInput) (*RegisterTaskDefinitionOutput, error)
Registers a new task definition from the supplied family and containerDefinitions. Optionally, you can add data volumes to your containers with the volumes parameter. For more information about task definition parameters and defaults, see Amazon ECS Task Definitions (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the Amazon EC2 Container Service Developer Guide.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(session.New()) params := &ecs.RegisterTaskDefinitionInput{ ContainerDefinitions: []*ecs.ContainerDefinition{ // Required { // Required Command: []*string{ aws.String("String"), // Required // More values... }, Cpu: aws.Int64(1), DisableNetworking: aws.Bool(true), DnsSearchDomains: []*string{ aws.String("String"), // Required // More values... }, DnsServers: []*string{ aws.String("String"), // Required // More values... }, DockerLabels: map[string]*string{ "Key": aws.String("String"), // Required // More values... }, DockerSecurityOptions: []*string{ aws.String("String"), // Required // More values... }, EntryPoint: []*string{ aws.String("String"), // Required // More values... }, Environment: []*ecs.KeyValuePair{ { // Required Name: aws.String("String"), Value: aws.String("String"), }, // More values... }, Essential: aws.Bool(true), ExtraHosts: []*ecs.HostEntry{ { // Required Hostname: aws.String("String"), // Required IpAddress: aws.String("String"), // Required }, // More values... }, Hostname: aws.String("String"), Image: aws.String("String"), Links: []*string{ aws.String("String"), // Required // More values... }, LogConfiguration: &ecs.LogConfiguration{ LogDriver: aws.String("LogDriver"), // Required Options: map[string]*string{ "Key": aws.String("String"), // Required // More values... }, }, Memory: aws.Int64(1), MountPoints: []*ecs.MountPoint{ { // Required ContainerPath: aws.String("String"), ReadOnly: aws.Bool(true), SourceVolume: aws.String("String"), }, // More values... }, Name: aws.String("String"), PortMappings: []*ecs.PortMapping{ { // Required ContainerPort: aws.Int64(1), HostPort: aws.Int64(1), Protocol: aws.String("TransportProtocol"), }, // More values... }, Privileged: aws.Bool(true), ReadonlyRootFilesystem: aws.Bool(true), Ulimits: []*ecs.Ulimit{ { // Required HardLimit: aws.Int64(1), // Required Name: aws.String("UlimitName"), // Required SoftLimit: aws.Int64(1), // Required }, // More values... }, User: aws.String("String"), VolumesFrom: []*ecs.VolumeFrom{ { // Required ReadOnly: aws.Bool(true), SourceContainer: aws.String("String"), }, // More values... }, WorkingDirectory: aws.String("String"), }, // More values... }, Family: aws.String("String"), // Required Volumes: []*ecs.Volume{ { // Required Host: &ecs.HostVolumeProperties{ SourcePath: aws.String("String"), }, Name: aws.String("String"), }, // More values... }, } resp, err := svc.RegisterTaskDefinition(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ECS) RegisterTaskDefinitionRequest ¶
func (c *ECS) RegisterTaskDefinitionRequest(input *RegisterTaskDefinitionInput) (req *request.Request, output *RegisterTaskDefinitionOutput)
RegisterTaskDefinitionRequest generates a request for the RegisterTaskDefinition operation.
func (*ECS) RunTask ¶
func (c *ECS) RunTask(input *RunTaskInput) (*RunTaskOutput, error)
Start a task using random placement and the default Amazon ECS scheduler. To use your own scheduler or place a task on a specific container instance, use StartTask instead.
The count parameter is limited to 10 tasks per call.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(session.New()) params := &ecs.RunTaskInput{ TaskDefinition: aws.String("String"), // Required Cluster: aws.String("String"), Count: aws.Int64(1), Overrides: &ecs.TaskOverride{ ContainerOverrides: []*ecs.ContainerOverride{ { // Required Command: []*string{ aws.String("String"), // Required // More values... }, Environment: []*ecs.KeyValuePair{ { // Required Name: aws.String("String"), Value: aws.String("String"), }, // More values... }, Name: aws.String("String"), }, // More values... }, }, StartedBy: aws.String("String"), } resp, err := svc.RunTask(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ECS) RunTaskRequest ¶
func (c *ECS) RunTaskRequest(input *RunTaskInput) (req *request.Request, output *RunTaskOutput)
RunTaskRequest generates a request for the RunTask operation.
func (*ECS) StartTask ¶
func (c *ECS) StartTask(input *StartTaskInput) (*StartTaskOutput, error)
Starts a new task from the specified task definition on the specified container instance or instances. To use the default Amazon ECS scheduler to place your task, use RunTask instead.
The list of container instances to start tasks on is limited to 10.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(session.New()) params := &ecs.StartTaskInput{ ContainerInstances: []*string{ // Required aws.String("String"), // Required // More values... }, TaskDefinition: aws.String("String"), // Required Cluster: aws.String("String"), Overrides: &ecs.TaskOverride{ ContainerOverrides: []*ecs.ContainerOverride{ { // Required Command: []*string{ aws.String("String"), // Required // More values... }, Environment: []*ecs.KeyValuePair{ { // Required Name: aws.String("String"), Value: aws.String("String"), }, // More values... }, Name: aws.String("String"), }, // More values... }, }, StartedBy: aws.String("String"), } resp, err := svc.StartTask(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ECS) StartTaskRequest ¶
func (c *ECS) StartTaskRequest(input *StartTaskInput) (req *request.Request, output *StartTaskOutput)
StartTaskRequest generates a request for the StartTask operation.
func (*ECS) StopTask ¶
func (c *ECS) StopTask(input *StopTaskInput) (*StopTaskOutput, error)
Stops a running task.
When StopTask is called on a task, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(session.New()) params := &ecs.StopTaskInput{ Task: aws.String("String"), // Required Cluster: aws.String("String"), Reason: aws.String("String"), } resp, err := svc.StopTask(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ECS) StopTaskRequest ¶
func (c *ECS) StopTaskRequest(input *StopTaskInput) (req *request.Request, output *StopTaskOutput)
StopTaskRequest generates a request for the StopTask operation.
func (*ECS) SubmitContainerStateChange ¶
func (c *ECS) SubmitContainerStateChange(input *SubmitContainerStateChangeInput) (*SubmitContainerStateChangeOutput, error)
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a container changed states.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(session.New()) params := &ecs.SubmitContainerStateChangeInput{ Cluster: aws.String("String"), ContainerName: aws.String("String"), ExitCode: aws.Int64(1), NetworkBindings: []*ecs.NetworkBinding{ { // Required BindIP: aws.String("String"), ContainerPort: aws.Int64(1), HostPort: aws.Int64(1), Protocol: aws.String("TransportProtocol"), }, // More values... }, Reason: aws.String("String"), Status: aws.String("String"), Task: aws.String("String"), } resp, err := svc.SubmitContainerStateChange(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ECS) SubmitContainerStateChangeRequest ¶
func (c *ECS) SubmitContainerStateChangeRequest(input *SubmitContainerStateChangeInput) (req *request.Request, output *SubmitContainerStateChangeOutput)
SubmitContainerStateChangeRequest generates a request for the SubmitContainerStateChange operation.
func (*ECS) SubmitTaskStateChange ¶
func (c *ECS) SubmitTaskStateChange(input *SubmitTaskStateChangeInput) (*SubmitTaskStateChangeOutput, error)
This action is only used by the Amazon EC2 Container Service agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a task changed states.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(session.New()) params := &ecs.SubmitTaskStateChangeInput{ Cluster: aws.String("String"), Reason: aws.String("String"), Status: aws.String("String"), Task: aws.String("String"), } resp, err := svc.SubmitTaskStateChange(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ECS) SubmitTaskStateChangeRequest ¶
func (c *ECS) SubmitTaskStateChangeRequest(input *SubmitTaskStateChangeInput) (req *request.Request, output *SubmitTaskStateChangeOutput)
SubmitTaskStateChangeRequest generates a request for the SubmitTaskStateChange operation.
func (*ECS) UpdateContainerAgent ¶
func (c *ECS) UpdateContainerAgent(input *UpdateContainerAgentInput) (*UpdateContainerAgentOutput, error)
Updates the Amazon ECS container agent on a specified container instance. Updating the Amazon ECS container agent does not interrupt running tasks or services on the container instance. The process for updating the agent differs depending on whether your container instance was launched with the Amazon ECS-optimized AMI or another operating system.
UpdateContainerAgent requires the Amazon ECS-optimized AMI or Amazon Linux with the ecs-init service installed and running. For help updating the Amazon ECS container agent on other operating systems, see Manually Updating the Amazon ECS Container Agent (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html#manually_update_agent) in the Amazon EC2 Container Service Developer Guide.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(session.New()) params := &ecs.UpdateContainerAgentInput{ ContainerInstance: aws.String("String"), // Required Cluster: aws.String("String"), } resp, err := svc.UpdateContainerAgent(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ECS) UpdateContainerAgentRequest ¶
func (c *ECS) UpdateContainerAgentRequest(input *UpdateContainerAgentInput) (req *request.Request, output *UpdateContainerAgentOutput)
UpdateContainerAgentRequest generates a request for the UpdateContainerAgent operation.
func (*ECS) UpdateService ¶
func (c *ECS) UpdateService(input *UpdateServiceInput) (*UpdateServiceOutput, error)
Modifies the desired count, deployment configuration, or task definition used in a service.
You can add to or subtract from the number of instantiations of a task definition in a service by specifying the cluster that the service is running in and a new desiredCount parameter.
You can use UpdateService to modify your task definition and deploy a new version of your service.
You can also update the deployment configuration of a service. When a deployment is triggered by updating the task definition of a service, the service scheduler uses the deployment configuration parameters, minimumHealthyPercent and maximumPercent, to determine the deployment strategy.
If the minimumHealthyPercent is below 100%, the scheduler can ignore the desiredCount temporarily during a deployment. For example, if your service has a desiredCount of four tasks, a minimumHealthyPercent of 50% allows the scheduler to stop two existing tasks before starting two new tasks. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state; tasks for services that do use a load balancer are considered healthy if they are in the RUNNING state and the container instance it is hosted on is reported as healthy by the load balancer.
The maximumPercent parameter represents an upper limit on the number of running tasks during a deployment, which enables you to define the deployment batch size. For example, if your service has a desiredCount of four tasks, a maximumPercent value of 200% starts four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available).
When UpdateService stops a task during a deployment, the equivalent of docker stop is issued to the containers running in the task. This results in a SIGTERM and a 30-second timeout, after which SIGKILL is sent and the containers are forcibly stopped. If the container handles the SIGTERM gracefully and exits within 30 seconds from receiving it, no SIGKILL is sent.
When the service scheduler launches new tasks, it attempts to balance them across the Availability Zones in your cluster with the following logic:
Determine which of the container instances in your cluster can support
your service's task definition (for example, they have the required CPU, memory, ports, and container instance attributes).
Sort the valid container instances by the fewest number of running tasks
for this service in the same Availability Zone as the instance. For example, if zone A has one running service task and zones B and C each have zero, valid container instances in either zone B or C are considered optimal for placement.
Place the new service task on a valid container instance in an optimal
Availability Zone (based on the previous steps), favoring container instances with the fewest number of running tasks for this service.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/ecs" ) func main() { svc := ecs.New(session.New()) params := &ecs.UpdateServiceInput{ Service: aws.String("String"), // Required Cluster: aws.String("String"), DeploymentConfiguration: &ecs.DeploymentConfiguration{ MaximumPercent: aws.Int64(1), MinimumHealthyPercent: aws.Int64(1), }, DesiredCount: aws.Int64(1), TaskDefinition: aws.String("String"), } resp, err := svc.UpdateService(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*ECS) UpdateServiceRequest ¶
func (c *ECS) UpdateServiceRequest(input *UpdateServiceInput) (req *request.Request, output *UpdateServiceOutput)
UpdateServiceRequest generates a request for the UpdateService operation.
func (*ECS) WaitUntilServicesInactive ¶
func (c *ECS) WaitUntilServicesInactive(input *DescribeServicesInput) error
func (*ECS) WaitUntilServicesStable ¶
func (c *ECS) WaitUntilServicesStable(input *DescribeServicesInput) error
func (*ECS) WaitUntilTasksRunning ¶
func (c *ECS) WaitUntilTasksRunning(input *DescribeTasksInput) error
func (*ECS) WaitUntilTasksStopped ¶
func (c *ECS) WaitUntilTasksStopped(input *DescribeTasksInput) error
type Failure ¶
type Failure struct { // The Amazon Resource Name (ARN) of the failed resource. Arn *string `locationName:"arn" type:"string"` // The reason for the failure. Reason *string `locationName:"reason" type:"string"` // contains filtered or unexported fields }
A failed resource.
type HostEntry ¶
type HostEntry struct { // The hostname to use in the /etc/hosts entry. Hostname *string `locationName:"hostname" type:"string" required:"true"` // The IP address to use in the /etc/hosts entry. IpAddress *string `locationName:"ipAddress" type:"string" required:"true"` // contains filtered or unexported fields }
Hostnames and IP address entries that are added to the /etc/hosts file of a container via the extraHosts parameter of its ContainerDefinition.
type HostVolumeProperties ¶
type HostVolumeProperties struct { // The path on the host container instance that is presented to the container. // If this parameter is empty, then the Docker daemon has assigned a host path // for you. If the host parameter contains a sourcePath file location, then // the data volume persists at the specified location on the host container // instance until you delete it manually. If the sourcePath value does not exist // on the host container instance, the Docker daemon creates it. If the location // does exist, the contents of the source path folder are exported. SourcePath *string `locationName:"sourcePath" type:"string"` // contains filtered or unexported fields }
Details on a container instance host volume.
func (HostVolumeProperties) GoString ¶
func (s HostVolumeProperties) GoString() string
GoString returns the string representation
func (HostVolumeProperties) String ¶
func (s HostVolumeProperties) String() string
String returns the string representation
type KeyValuePair ¶
type KeyValuePair struct { // The name of the key value pair. For environment variables, this is the name // of the environment variable. Name *string `locationName:"name" type:"string"` // The value of the key value pair. For environment variables, this is the value // of the environment variable. Value *string `locationName:"value" type:"string"` // contains filtered or unexported fields }
A key and value pair object.
func (KeyValuePair) GoString ¶
func (s KeyValuePair) GoString() string
GoString returns the string representation
func (KeyValuePair) String ¶
func (s KeyValuePair) String() string
String returns the string representation
type ListClustersInput ¶
type ListClustersInput struct { // The maximum number of cluster results returned by ListClusters in paginated // output. When this parameter is used, ListClusters only returns maxResults // results in a single page along with a nextToken response element. The remaining // results of the initial request can be seen by sending another ListClusters // request with the returned nextToken value. This value can be between 1 and // 100. If this parameter is not used, then ListClusters returns up to 100 results // and a nextToken value if applicable. MaxResults *int64 `locationName:"maxResults" type:"integer"` // The nextToken value returned from a previous paginated ListClusters request // where maxResults was used and the results exceeded the value of that parameter. // Pagination continues from the end of the previous results that returned the // nextToken value. This value is null when there are no more results to return. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
func (ListClustersInput) GoString ¶
func (s ListClustersInput) GoString() string
GoString returns the string representation
func (ListClustersInput) String ¶
func (s ListClustersInput) String() string
String returns the string representation
type ListClustersOutput ¶
type ListClustersOutput struct { // The list of full Amazon Resource Name (ARN) entries for each cluster associated // with your account. ClusterArns []*string `locationName:"clusterArns" type:"list"` // The nextToken value to include in a future ListClusters request. When the // results of a ListClusters request exceed maxResults, this value can be used // to retrieve the next page of results. This value is null when there are no // more results to return. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
func (ListClustersOutput) GoString ¶
func (s ListClustersOutput) GoString() string
GoString returns the string representation
func (ListClustersOutput) String ¶
func (s ListClustersOutput) String() string
String returns the string representation
type ListContainerInstancesInput ¶
type ListContainerInstancesInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster that hosts // the container instances to list. If you do not specify a cluster, the default // cluster is assumed.. Cluster *string `locationName:"cluster" type:"string"` // The maximum number of container instance results returned by ListContainerInstances // in paginated output. When this parameter is used, ListContainerInstances // only returns maxResults results in a single page along with a nextToken response // element. The remaining results of the initial request can be seen by sending // another ListContainerInstances request with the returned nextToken value. // This value can be between 1 and 100. If this parameter is not used, then // ListContainerInstances returns up to 100 results and a nextToken value if // applicable. MaxResults *int64 `locationName:"maxResults" type:"integer"` // The nextToken value returned from a previous paginated ListContainerInstances // request where maxResults was used and the results exceeded the value of that // parameter. Pagination continues from the end of the previous results that // returned the nextToken value. This value is null when there are no more results // to return. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
func (ListContainerInstancesInput) GoString ¶
func (s ListContainerInstancesInput) GoString() string
GoString returns the string representation
func (ListContainerInstancesInput) String ¶
func (s ListContainerInstancesInput) String() string
String returns the string representation
type ListContainerInstancesOutput ¶
type ListContainerInstancesOutput struct { // The list of container instances with full Amazon Resource Name (ARN) entries // for each container instance associated with the specified cluster. ContainerInstanceArns []*string `locationName:"containerInstanceArns" type:"list"` // The nextToken value to include in a future ListContainerInstances request. // When the results of a ListContainerInstances request exceed maxResults, this // value can be used to retrieve the next page of results. This value is null // when there are no more results to return. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
func (ListContainerInstancesOutput) GoString ¶
func (s ListContainerInstancesOutput) GoString() string
GoString returns the string representation
func (ListContainerInstancesOutput) String ¶
func (s ListContainerInstancesOutput) String() string
String returns the string representation
type ListServicesInput ¶
type ListServicesInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster that hosts // the services to list. If you do not specify a cluster, the default cluster // is assumed.. Cluster *string `locationName:"cluster" type:"string"` // The maximum number of container instance results returned by ListServices // in paginated output. When this parameter is used, ListServices only returns // maxResults results in a single page along with a nextToken response element. // The remaining results of the initial request can be seen by sending another // ListServices request with the returned nextToken value. This value can be // between 1 and 10. If this parameter is not used, then ListServices returns // up to 10 results and a nextToken value if applicable. MaxResults *int64 `locationName:"maxResults" type:"integer"` // The nextToken value returned from a previous paginated ListServices request // where maxResults was used and the results exceeded the value of that parameter. // Pagination continues from the end of the previous results that returned the // nextToken value. This value is null when there are no more results to return. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
func (ListServicesInput) GoString ¶
func (s ListServicesInput) GoString() string
GoString returns the string representation
func (ListServicesInput) String ¶
func (s ListServicesInput) String() string
String returns the string representation
type ListServicesOutput ¶
type ListServicesOutput struct { // The nextToken value to include in a future ListServices request. When the // results of a ListServices request exceed maxResults, this value can be used // to retrieve the next page of results. This value is null when there are no // more results to return. NextToken *string `locationName:"nextToken" type:"string"` // The list of full Amazon Resource Name (ARN) entries for each service associated // with the specified cluster. ServiceArns []*string `locationName:"serviceArns" type:"list"` // contains filtered or unexported fields }
func (ListServicesOutput) GoString ¶
func (s ListServicesOutput) GoString() string
GoString returns the string representation
func (ListServicesOutput) String ¶
func (s ListServicesOutput) String() string
String returns the string representation
type ListTaskDefinitionFamiliesInput ¶
type ListTaskDefinitionFamiliesInput struct { // The familyPrefix is a string that is used to filter the results of ListTaskDefinitionFamilies. // If you specify a familyPrefix, only task definition family names that begin // with the familyPrefix string are returned. FamilyPrefix *string `locationName:"familyPrefix" type:"string"` // The maximum number of task definition family results returned by ListTaskDefinitionFamilies // in paginated output. When this parameter is used, ListTaskDefinitions only // returns maxResults results in a single page along with a nextToken response // element. The remaining results of the initial request can be seen by sending // another ListTaskDefinitionFamilies request with the returned nextToken value. // This value can be between 1 and 100. If this parameter is not used, then // ListTaskDefinitionFamilies returns up to 100 results and a nextToken value // if applicable. MaxResults *int64 `locationName:"maxResults" type:"integer"` // The nextToken value returned from a previous paginated ListTaskDefinitionFamilies // request where maxResults was used and the results exceeded the value of that // parameter. Pagination continues from the end of the previous results that // returned the nextToken value. This value is null when there are no more results // to return. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
func (ListTaskDefinitionFamiliesInput) GoString ¶
func (s ListTaskDefinitionFamiliesInput) GoString() string
GoString returns the string representation
func (ListTaskDefinitionFamiliesInput) String ¶
func (s ListTaskDefinitionFamiliesInput) String() string
String returns the string representation
type ListTaskDefinitionFamiliesOutput ¶
type ListTaskDefinitionFamiliesOutput struct { // The list of task definition family names that match the ListTaskDefinitionFamilies // request. Families []*string `locationName:"families" type:"list"` // The nextToken value to include in a future ListTaskDefinitionFamilies request. // When the results of a ListTaskDefinitionFamilies request exceed maxResults, // this value can be used to retrieve the next page of results. This value is // null when there are no more results to return. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
func (ListTaskDefinitionFamiliesOutput) GoString ¶
func (s ListTaskDefinitionFamiliesOutput) GoString() string
GoString returns the string representation
func (ListTaskDefinitionFamiliesOutput) String ¶
func (s ListTaskDefinitionFamiliesOutput) String() string
String returns the string representation
type ListTaskDefinitionsInput ¶
type ListTaskDefinitionsInput struct { // The full family name with which to filter the ListTaskDefinitions results. // Specifying a familyPrefix limits the listed task definitions to task definition // revisions that belong to that family. FamilyPrefix *string `locationName:"familyPrefix" type:"string"` // The maximum number of task definition results returned by ListTaskDefinitions // in paginated output. When this parameter is used, ListTaskDefinitions only // returns maxResults results in a single page along with a nextToken response // element. The remaining results of the initial request can be seen by sending // another ListTaskDefinitions request with the returned nextToken value. This // value can be between 1 and 100. If this parameter is not used, then ListTaskDefinitions // returns up to 100 results and a nextToken value if applicable. MaxResults *int64 `locationName:"maxResults" type:"integer"` // The nextToken value returned from a previous paginated ListTaskDefinitions // request where maxResults was used and the results exceeded the value of that // parameter. Pagination continues from the end of the previous results that // returned the nextToken value. This value is null when there are no more results // to return. NextToken *string `locationName:"nextToken" type:"string"` // The order in which to sort the results. Valid values are ASC and DESC. By // default (ASC), task definitions are listed lexicographically by family name // and in ascending numerical order by revision so that the newest task definitions // in a family are listed last. Setting this parameter to DESC reverses the // sort order on family name and revision so that the newest task definitions // in a family are listed first. Sort *string `locationName:"sort" type:"string" enum:"SortOrder"` // The task definition status with which to filter the ListTaskDefinitions results. // By default, only ACTIVE task definitions are listed. By setting this parameter // to INACTIVE, you can view task definitions that are INACTIVE as long as an // active task or service still references them. If you paginate the resulting // output, be sure to keep the status value constant in each subsequent request. Status *string `locationName:"status" type:"string" enum:"TaskDefinitionStatus"` // contains filtered or unexported fields }
func (ListTaskDefinitionsInput) GoString ¶
func (s ListTaskDefinitionsInput) GoString() string
GoString returns the string representation
func (ListTaskDefinitionsInput) String ¶
func (s ListTaskDefinitionsInput) String() string
String returns the string representation
type ListTaskDefinitionsOutput ¶
type ListTaskDefinitionsOutput struct { // The nextToken value to include in a future ListTaskDefinitions request. When // the results of a ListTaskDefinitions request exceed maxResults, this value // can be used to retrieve the next page of results. This value is null when // there are no more results to return. NextToken *string `locationName:"nextToken" type:"string"` // The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefinitions // request. TaskDefinitionArns []*string `locationName:"taskDefinitionArns" type:"list"` // contains filtered or unexported fields }
func (ListTaskDefinitionsOutput) GoString ¶
func (s ListTaskDefinitionsOutput) GoString() string
GoString returns the string representation
func (ListTaskDefinitionsOutput) String ¶
func (s ListTaskDefinitionsOutput) String() string
String returns the string representation
type ListTasksInput ¶
type ListTasksInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster that hosts // the tasks to list. If you do not specify a cluster, the default cluster is // assumed.. Cluster *string `locationName:"cluster" type:"string"` // The container instance ID or full Amazon Resource Name (ARN) of the container // instance with which to filter the ListTasks results. Specifying a containerInstance // limits the results to tasks that belong to that container instance. ContainerInstance *string `locationName:"containerInstance" type:"string"` // The task status with which to filter the ListTasks results. Specifying a // desiredStatus of STOPPED limits the results to tasks that are in the STOPPED // status, which can be useful for debugging tasks that are not starting properly // or have died or finished. The default status filter is RUNNING. DesiredStatus *string `locationName:"desiredStatus" type:"string" enum:"DesiredStatus"` // The name of the family with which to filter the ListTasks results. Specifying // a family limits the results to tasks that belong to that family. Family *string `locationName:"family" type:"string"` // The maximum number of task results returned by ListTasks in paginated output. // When this parameter is used, ListTasks only returns maxResults results in // a single page along with a nextToken response element. The remaining results // of the initial request can be seen by sending another ListTasks request with // the returned nextToken value. This value can be between 1 and 100. If this // parameter is not used, then ListTasks returns up to 100 results and a nextToken // value if applicable. MaxResults *int64 `locationName:"maxResults" type:"integer"` // The nextToken value returned from a previous paginated ListTasks request // where maxResults was used and the results exceeded the value of that parameter. // Pagination continues from the end of the previous results that returned the // nextToken value. This value is null when there are no more results to return. NextToken *string `locationName:"nextToken" type:"string"` // The name of the service with which to filter the ListTasks results. Specifying // a serviceName limits the results to tasks that belong to that service. ServiceName *string `locationName:"serviceName" type:"string"` // The startedBy value with which to filter the task results. Specifying a startedBy // value limits the results to tasks that were started with that value. StartedBy *string `locationName:"startedBy" type:"string"` // contains filtered or unexported fields }
func (ListTasksInput) GoString ¶
func (s ListTasksInput) GoString() string
GoString returns the string representation
func (ListTasksInput) String ¶
func (s ListTasksInput) String() string
String returns the string representation
type ListTasksOutput ¶
type ListTasksOutput struct { // The nextToken value to include in a future ListTasks request. When the results // of a ListTasks request exceed maxResults, this value can be used to retrieve // the next page of results. This value is null when there are no more results // to return. NextToken *string `locationName:"nextToken" type:"string"` // The list of task Amazon Resource Name (ARN) entries for the ListTasks request. TaskArns []*string `locationName:"taskArns" type:"list"` // contains filtered or unexported fields }
func (ListTasksOutput) GoString ¶
func (s ListTasksOutput) GoString() string
GoString returns the string representation
func (ListTasksOutput) String ¶
func (s ListTasksOutput) String() string
String returns the string representation
type LoadBalancer ¶
type LoadBalancer struct { // The name of the container (as it appears in a container definition) to associate // with the load balancer. ContainerName *string `locationName:"containerName" type:"string"` // The port on the container to associate with the load balancer. This port // must correspond to a containerPort in the service's task definition. Your // container instances must allow ingress traffic on the hostPort of the port // mapping. ContainerPort *int64 `locationName:"containerPort" type:"integer"` // The name of the load balancer. LoadBalancerName *string `locationName:"loadBalancerName" type:"string"` // contains filtered or unexported fields }
Details on a load balancer that is used with a service.
func (LoadBalancer) GoString ¶
func (s LoadBalancer) GoString() string
GoString returns the string representation
func (LoadBalancer) String ¶
func (s LoadBalancer) String() string
String returns the string representation
type LogConfiguration ¶
type LogConfiguration struct { // The log driver to use for the container. This parameter requires version // 1.18 of the Docker Remote API or greater on your container instance. To check // the Docker Remote API version on your container instance, log into your container // instance and run the following command: sudo docker version | grep "Server // API version" LogDriver *string `locationName:"logDriver" type:"string" required:"true" enum:"LogDriver"` // The configuration options to send to the log driver. This parameter requires // version 1.19 of the Docker Remote API or greater on your container instance. // To check the Docker Remote API version on your container instance, log into // your container instance and run the following command: sudo docker version // | grep "Server API version" Options map[string]*string `locationName:"options" type:"map"` // contains filtered or unexported fields }
Log configuration options to send to a custom log driver for the container.
func (LogConfiguration) GoString ¶
func (s LogConfiguration) GoString() string
GoString returns the string representation
func (LogConfiguration) String ¶
func (s LogConfiguration) String() string
String returns the string representation
func (*LogConfiguration) Validate ¶
func (s *LogConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type MountPoint ¶
type MountPoint struct { // The path on the container to mount the host volume at. ContainerPath *string `locationName:"containerPath" type:"string"` // If this value is true, the container has read-only access to the volume. // If this value is false, then the container can write to the volume. The default // value is false. ReadOnly *bool `locationName:"readOnly" type:"boolean"` // The name of the volume to mount. SourceVolume *string `locationName:"sourceVolume" type:"string"` // contains filtered or unexported fields }
Details on a volume mount point that is used in a container definition.
func (MountPoint) GoString ¶
func (s MountPoint) GoString() string
GoString returns the string representation
func (MountPoint) String ¶
func (s MountPoint) String() string
String returns the string representation
type NetworkBinding ¶
type NetworkBinding struct { // The IP address that the container is bound to on the container instance. BindIP *string `locationName:"bindIP" type:"string"` // The port number on the container that is be used with the network binding. ContainerPort *int64 `locationName:"containerPort" type:"integer"` // The port number on the host that is used with the network binding. HostPort *int64 `locationName:"hostPort" type:"integer"` // The protocol used for the network binding. Protocol *string `locationName:"protocol" type:"string" enum:"TransportProtocol"` // contains filtered or unexported fields }
Details on the network bindings between a container and its host container instance. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.
func (NetworkBinding) GoString ¶
func (s NetworkBinding) GoString() string
GoString returns the string representation
func (NetworkBinding) String ¶
func (s NetworkBinding) String() string
String returns the string representation
type PortMapping ¶
type PortMapping struct { // The port number on the container that is bound to the user-specified or automatically // assigned host port. If you specify a container port and not a host port, // your container automatically receives a host port in the ephemeral port range // (for more information, see hostPort). ContainerPort *int64 `locationName:"containerPort" type:"integer"` // The port number on the container instance to reserve for your container. // You can specify a non-reserved host port for your container port mapping, // or you can omit the hostPort (or set it to 0) while specifying a containerPort // and your container automatically receives a port in the ephemeral port range // for your container instance operating system and Docker version. // // The default ephemeral port range is 49153 to 65535, and this range is used // for Docker versions prior to 1.6.0. For Docker version 1.6.0 and later, the // Docker daemon tries to read the ephemeral port range from /proc/sys/net/ipv4/ip_local_port_range; // if this kernel parameter is unavailable, the default ephemeral port range // is used. You should not attempt to specify a host port in the ephemeral port // range, because these are reserved for automatic assignment. In general, ports // below 32768 are outside of the ephemeral port range. // // The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, // and the Amazon ECS container agent port 51678. Any host port that was previously // specified in a running task is also reserved while the task is running (after // a task stops, the host port is released).The current reserved ports are displayed // in the remainingResources of DescribeContainerInstances output, and a container // instance may have up to 50 reserved ports at a time, including the default // reserved ports (automatically assigned ports do not count toward this limit). HostPort *int64 `locationName:"hostPort" type:"integer"` // The protocol used for the port mapping. Valid values are tcp and udp. The // default is tcp. Protocol *string `locationName:"protocol" type:"string" enum:"TransportProtocol"` // contains filtered or unexported fields }
Port mappings allow containers to access ports on the host container instance to send or receive traffic. Port mappings are specified as part of the container definition. After a task reaches the RUNNING status, manual and automatic host and container port assignments are visible in the networkBindings section of DescribeTasks API responses.
func (PortMapping) GoString ¶
func (s PortMapping) GoString() string
GoString returns the string representation
func (PortMapping) String ¶
func (s PortMapping) String() string
String returns the string representation
type RegisterContainerInstanceInput ¶
type RegisterContainerInstanceInput struct { // The container instance attributes that this container instance supports. Attributes []*Attribute `locationName:"attributes" type:"list"` // The short name or full Amazon Resource Name (ARN) of the cluster with which // to register your container instance. If you do not specify a cluster, the // default cluster is assumed.. Cluster *string `locationName:"cluster" type:"string"` // The Amazon Resource Name (ARN) of the container instance (if it was previously // registered). ContainerInstanceArn *string `locationName:"containerInstanceArn" type:"string"` // The instance identity document for the EC2 instance to register. This document // can be found by running the following command from the instance: curl http://169.254.169.254/latest/dynamic/instance-identity/document/ InstanceIdentityDocument *string `locationName:"instanceIdentityDocument" type:"string"` // The instance identity document signature for the EC2 instance to register. // This signature can be found by running the following command from the instance: // curl http://169.254.169.254/latest/dynamic/instance-identity/signature/ InstanceIdentityDocumentSignature *string `locationName:"instanceIdentityDocumentSignature" type:"string"` // The resources available on the instance. TotalResources []*Resource `locationName:"totalResources" type:"list"` // The version information for the Amazon ECS container agent and Docker daemon // running on the container instance. VersionInfo *VersionInfo `locationName:"versionInfo" type:"structure"` // contains filtered or unexported fields }
func (RegisterContainerInstanceInput) GoString ¶
func (s RegisterContainerInstanceInput) GoString() string
GoString returns the string representation
func (RegisterContainerInstanceInput) String ¶
func (s RegisterContainerInstanceInput) String() string
String returns the string representation
func (*RegisterContainerInstanceInput) Validate ¶
func (s *RegisterContainerInstanceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RegisterContainerInstanceOutput ¶
type RegisterContainerInstanceOutput struct { // An EC2 instance that is running the Amazon ECS agent and has been registered // with a cluster. ContainerInstance *ContainerInstance `locationName:"containerInstance" type:"structure"` // contains filtered or unexported fields }
func (RegisterContainerInstanceOutput) GoString ¶
func (s RegisterContainerInstanceOutput) GoString() string
GoString returns the string representation
func (RegisterContainerInstanceOutput) String ¶
func (s RegisterContainerInstanceOutput) String() string
String returns the string representation
type RegisterTaskDefinitionInput ¶
type RegisterTaskDefinitionInput struct { // A list of container definitions in JSON format that describe the different // containers that make up your task. ContainerDefinitions []*ContainerDefinition `locationName:"containerDefinitions" type:"list" required:"true"` // You must specify a family for a task definition, which allows you to track // multiple versions of the same task definition. The family is used as a name // for your task definition. Up to 255 letters (uppercase and lowercase), numbers, // hyphens, and underscores are allowed. Family *string `locationName:"family" type:"string" required:"true"` // A list of volume definitions in JSON format that containers in your task // may use. Volumes []*Volume `locationName:"volumes" type:"list"` // contains filtered or unexported fields }
func (RegisterTaskDefinitionInput) GoString ¶
func (s RegisterTaskDefinitionInput) GoString() string
GoString returns the string representation
func (RegisterTaskDefinitionInput) String ¶
func (s RegisterTaskDefinitionInput) String() string
String returns the string representation
func (*RegisterTaskDefinitionInput) Validate ¶
func (s *RegisterTaskDefinitionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RegisterTaskDefinitionOutput ¶
type RegisterTaskDefinitionOutput struct { // The full description of the registered task definition. TaskDefinition *TaskDefinition `locationName:"taskDefinition" type:"structure"` // contains filtered or unexported fields }
func (RegisterTaskDefinitionOutput) GoString ¶
func (s RegisterTaskDefinitionOutput) GoString() string
GoString returns the string representation
func (RegisterTaskDefinitionOutput) String ¶
func (s RegisterTaskDefinitionOutput) String() string
String returns the string representation
type Resource ¶
type Resource struct { // When the doubleValue type is set, the value of the resource must be a double // precision floating-point type. DoubleValue *float64 `locationName:"doubleValue" type:"double"` // When the integerValue type is set, the value of the resource must be an integer. IntegerValue *int64 `locationName:"integerValue" type:"integer"` // When the longValue type is set, the value of the resource must be an extended // precision floating-point type. LongValue *int64 `locationName:"longValue" type:"long"` // The name of the resource, such as CPU, MEMORY, PORTS, or a user-defined resource. Name *string `locationName:"name" type:"string"` // When the stringSetValue type is set, the value of the resource must be a // string type. StringSetValue []*string `locationName:"stringSetValue" type:"list"` // The type of the resource, such as INTEGER, DOUBLE, LONG, or STRINGSET. Type *string `locationName:"type" type:"string"` // contains filtered or unexported fields }
Describes the resources available for a container instance.
type RunTaskInput ¶
type RunTaskInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster on which // to run your task. If you do not specify a cluster, the default cluster is // assumed.. Cluster *string `locationName:"cluster" type:"string"` // The number of instantiations of the specified task to place on your cluster. // // The count parameter is limited to 10 tasks per call. Count *int64 `locationName:"count" type:"integer"` // A list of container overrides in JSON format that specify the name of a container // in the specified task definition and the overrides it should receive. You // can override the default command for a container (that is specified in the // task definition or Docker image) with a command override. You can also override // existing environment variables (that are specified in the task definition // or Docker image) on a container or add new environment variables to it with // an environment override. // // A total of 8192 characters are allowed for overrides. This limit includes // the JSON formatting characters of the override structure. Overrides *TaskOverride `locationName:"overrides" type:"structure"` // An optional tag specified when a task is started. For example if you automatically // trigger a task to run a batch process job, you could apply a unique identifier // for that job to your task with the startedBy parameter. You can then identify // which tasks belong to that job by filtering the results of a ListTasks call // with the startedBy value. // // If a task is started by an Amazon ECS service, then the startedBy parameter // contains the deployment ID of the service that starts it. StartedBy *string `locationName:"startedBy" type:"string"` // The family and revision (family:revision) or full Amazon Resource Name (ARN) // of the task definition to run. If a revision is not specified, the latest // ACTIVE revision is used. TaskDefinition *string `locationName:"taskDefinition" type:"string" required:"true"` // contains filtered or unexported fields }
func (RunTaskInput) GoString ¶
func (s RunTaskInput) GoString() string
GoString returns the string representation
func (RunTaskInput) String ¶
func (s RunTaskInput) String() string
String returns the string representation
func (*RunTaskInput) Validate ¶
func (s *RunTaskInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RunTaskOutput ¶
type RunTaskOutput struct { // Any failures associated with the call. Failures []*Failure `locationName:"failures" type:"list"` // A full description of the tasks that were run. Each task that was successfully // placed on your cluster are described here. Tasks []*Task `locationName:"tasks" type:"list"` // contains filtered or unexported fields }
func (RunTaskOutput) GoString ¶
func (s RunTaskOutput) GoString() string
GoString returns the string representation
func (RunTaskOutput) String ¶
func (s RunTaskOutput) String() string
String returns the string representation
type Service ¶
type Service struct { // The Amazon Resource Name (ARN) of the of the cluster that hosts the service. ClusterArn *string `locationName:"clusterArn" type:"string"` // Optional deployment parameters that control how many tasks run during the // deployment and the ordering of stopping and starting tasks. DeploymentConfiguration *DeploymentConfiguration `locationName:"deploymentConfiguration" type:"structure"` // The current state of deployments for the service. Deployments []*Deployment `locationName:"deployments" type:"list"` // The desired number of instantiations of the task definition to keep running // on the service. This value is specified when the service is created with // CreateService, and it can be modified with UpdateService. DesiredCount *int64 `locationName:"desiredCount" type:"integer"` // The event stream for your service. A maximum of 100 of the latest events // are displayed. Events []*ServiceEvent `locationName:"events" type:"list"` // A list of load balancer objects, containing the load balancer name, the container // name (as it appears in a container definition), and the container port to // access from the load balancer. LoadBalancers []*LoadBalancer `locationName:"loadBalancers" type:"list"` // The number of tasks in the cluster that are in the PENDING state. PendingCount *int64 `locationName:"pendingCount" type:"integer"` // The Amazon Resource Name (ARN) of the IAM role associated with the service // that allows the Amazon ECS container agent to register container instances // with a load balancer. RoleArn *string `locationName:"roleArn" type:"string"` // The number of tasks in the cluster that are in the RUNNING state. RunningCount *int64 `locationName:"runningCount" type:"integer"` // The Amazon Resource Name (ARN) that identifies the service. The ARN contains // the arn:aws:ecs namespace, followed by the region of the service, the AWS // account ID of the service owner, the service namespace, and then the service // name. For example, arn:aws:ecs:region:012345678910:service/my-service. ServiceArn *string `locationName:"serviceArn" type:"string"` // The name of your service. Up to 255 letters (uppercase and lowercase), numbers, // hyphens, and underscores are allowed. Service names must be unique within // a cluster, but you can have similarly named services in multiple clusters // within a region or across multiple regions. ServiceName *string `locationName:"serviceName" type:"string"` // The status of the service. The valid values are ACTIVE, DRAINING, or INACTIVE. Status *string `locationName:"status" type:"string"` // The task definition to use for tasks in the service. This value is specified // when the service is created with CreateService, and it can be modified with // UpdateService. TaskDefinition *string `locationName:"taskDefinition" type:"string"` // contains filtered or unexported fields }
Details on a service within a cluster
type ServiceEvent ¶
type ServiceEvent struct { // The Unix time in seconds and milliseconds when the event was triggered. CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"unix"` // The ID string of the event. Id *string `locationName:"id" type:"string"` // The event message. Message *string `locationName:"message" type:"string"` // contains filtered or unexported fields }
Details on an event associated with a service.
func (ServiceEvent) GoString ¶
func (s ServiceEvent) GoString() string
GoString returns the string representation
func (ServiceEvent) String ¶
func (s ServiceEvent) String() string
String returns the string representation
type StartTaskInput ¶
type StartTaskInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster on which // to start your task. If you do not specify a cluster, the default cluster // is assumed.. Cluster *string `locationName:"cluster" type:"string"` // The container instance IDs or full Amazon Resource Name (ARN) entries for // the container instances on which you would like to place your task. // // The list of container instances to start tasks on is limited to 10. ContainerInstances []*string `locationName:"containerInstances" type:"list" required:"true"` // A list of container overrides in JSON format that specify the name of a container // in the specified task definition and the overrides it should receive. You // can override the default command for a container (that is specified in the // task definition or Docker image) with a command override. You can also override // existing environment variables (that are specified in the task definition // or Docker image) on a container or add new environment variables to it with // an environment override. // // A total of 8192 characters are allowed for overrides. This limit includes // the JSON formatting characters of the override structure. Overrides *TaskOverride `locationName:"overrides" type:"structure"` // An optional tag specified when a task is started. For example if you automatically // trigger a task to run a batch process job, you could apply a unique identifier // for that job to your task with the startedBy parameter. You can then identify // which tasks belong to that job by filtering the results of a ListTasks call // with the startedBy value. // // If a task is started by an Amazon ECS service, then the startedBy parameter // contains the deployment ID of the service that starts it. StartedBy *string `locationName:"startedBy" type:"string"` // The family and revision (family:revision) or full Amazon Resource Name (ARN) // of the task definition to start. If a revision is not specified, the latest // ACTIVE revision is used. TaskDefinition *string `locationName:"taskDefinition" type:"string" required:"true"` // contains filtered or unexported fields }
func (StartTaskInput) GoString ¶
func (s StartTaskInput) GoString() string
GoString returns the string representation
func (StartTaskInput) String ¶
func (s StartTaskInput) String() string
String returns the string representation
func (*StartTaskInput) Validate ¶
func (s *StartTaskInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StartTaskOutput ¶
type StartTaskOutput struct { // Any failures associated with the call. Failures []*Failure `locationName:"failures" type:"list"` // A full description of the tasks that were started. Each task that was successfully // placed on your container instances are described here. Tasks []*Task `locationName:"tasks" type:"list"` // contains filtered or unexported fields }
func (StartTaskOutput) GoString ¶
func (s StartTaskOutput) GoString() string
GoString returns the string representation
func (StartTaskOutput) String ¶
func (s StartTaskOutput) String() string
String returns the string representation
type StopTaskInput ¶
type StopTaskInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster that hosts // the task to stop. If you do not specify a cluster, the default cluster is // assumed.. Cluster *string `locationName:"cluster" type:"string"` // An optional message specified when a task is stopped. For example, if you // are using a custom scheduler, you can use this parameter to specify the reason // for stopping the task here, and the message will appear in subsequent DescribeTasks // API operations on this task. Up to 255 characters are allowed in this message. Reason *string `locationName:"reason" type:"string"` // The task ID or full Amazon Resource Name (ARN) entry of the task to stop. Task *string `locationName:"task" type:"string" required:"true"` // contains filtered or unexported fields }
func (StopTaskInput) GoString ¶
func (s StopTaskInput) GoString() string
GoString returns the string representation
func (StopTaskInput) String ¶
func (s StopTaskInput) String() string
String returns the string representation
func (*StopTaskInput) Validate ¶
func (s *StopTaskInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StopTaskOutput ¶
type StopTaskOutput struct { // Details on a task in a cluster. Task *Task `locationName:"task" type:"structure"` // contains filtered or unexported fields }
func (StopTaskOutput) GoString ¶
func (s StopTaskOutput) GoString() string
GoString returns the string representation
func (StopTaskOutput) String ¶
func (s StopTaskOutput) String() string
String returns the string representation
type SubmitContainerStateChangeInput ¶
type SubmitContainerStateChangeInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster that hosts // the container. Cluster *string `locationName:"cluster" type:"string"` // The name of the container. ContainerName *string `locationName:"containerName" type:"string"` // The exit code returned for the state change request. ExitCode *int64 `locationName:"exitCode" type:"integer"` // The network bindings of the container. NetworkBindings []*NetworkBinding `locationName:"networkBindings" type:"list"` // The reason for the state change request. Reason *string `locationName:"reason" type:"string"` // The status of the state change request. Status *string `locationName:"status" type:"string"` // The task ID or full Amazon Resource Name (ARN) of the task that hosts the // container. Task *string `locationName:"task" type:"string"` // contains filtered or unexported fields }
func (SubmitContainerStateChangeInput) GoString ¶
func (s SubmitContainerStateChangeInput) GoString() string
GoString returns the string representation
func (SubmitContainerStateChangeInput) String ¶
func (s SubmitContainerStateChangeInput) String() string
String returns the string representation
type SubmitContainerStateChangeOutput ¶
type SubmitContainerStateChangeOutput struct { // Acknowledgement of the state change. Acknowledgment *string `locationName:"acknowledgment" type:"string"` // contains filtered or unexported fields }
func (SubmitContainerStateChangeOutput) GoString ¶
func (s SubmitContainerStateChangeOutput) GoString() string
GoString returns the string representation
func (SubmitContainerStateChangeOutput) String ¶
func (s SubmitContainerStateChangeOutput) String() string
String returns the string representation
type SubmitTaskStateChangeInput ¶
type SubmitTaskStateChangeInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster that hosts // the task. Cluster *string `locationName:"cluster" type:"string"` // The reason for the state change request. Reason *string `locationName:"reason" type:"string"` // The status of the state change request. Status *string `locationName:"status" type:"string"` // The task ID or full Amazon Resource Name (ARN) of the task in the state change // request. Task *string `locationName:"task" type:"string"` // contains filtered or unexported fields }
func (SubmitTaskStateChangeInput) GoString ¶
func (s SubmitTaskStateChangeInput) GoString() string
GoString returns the string representation
func (SubmitTaskStateChangeInput) String ¶
func (s SubmitTaskStateChangeInput) String() string
String returns the string representation
type SubmitTaskStateChangeOutput ¶
type SubmitTaskStateChangeOutput struct { // Acknowledgement of the state change. Acknowledgment *string `locationName:"acknowledgment" type:"string"` // contains filtered or unexported fields }
func (SubmitTaskStateChangeOutput) GoString ¶
func (s SubmitTaskStateChangeOutput) GoString() string
GoString returns the string representation
func (SubmitTaskStateChangeOutput) String ¶
func (s SubmitTaskStateChangeOutput) String() string
String returns the string representation
type Task ¶
type Task struct { // The Amazon Resource Name (ARN) of the of the cluster that hosts the task. ClusterArn *string `locationName:"clusterArn" type:"string"` // The Amazon Resource Name (ARN) of the container instances that host the task. ContainerInstanceArn *string `locationName:"containerInstanceArn" type:"string"` // The containers associated with the task. Containers []*Container `locationName:"containers" type:"list"` // The Unix time in seconds and milliseconds when the task was created (the // task entered the PENDING state). CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"unix"` // The desired status of the task. DesiredStatus *string `locationName:"desiredStatus" type:"string"` // The last known status of the task. LastStatus *string `locationName:"lastStatus" type:"string"` // One or more container overrides. Overrides *TaskOverride `locationName:"overrides" type:"structure"` // The Unix time in seconds and milliseconds when the task was started (the // task transitioned from the PENDING state to the RUNNING state). StartedAt *time.Time `locationName:"startedAt" type:"timestamp" timestampFormat:"unix"` // The tag specified when a task is started. If the task is started by an Amazon // ECS service, then the startedBy parameter contains the deployment ID of the // service that starts it. StartedBy *string `locationName:"startedBy" type:"string"` // The Unix time in seconds and milliseconds when the task was stopped (the // task transitioned from the RUNNING state to the STOPPED state). StoppedAt *time.Time `locationName:"stoppedAt" type:"timestamp" timestampFormat:"unix"` // The reason the task was stopped. StoppedReason *string `locationName:"stoppedReason" type:"string"` // The Amazon Resource Name (ARN) of the task. TaskArn *string `locationName:"taskArn" type:"string"` // The Amazon Resource Name (ARN) of the of the task definition that creates // the task. TaskDefinitionArn *string `locationName:"taskDefinitionArn" type:"string"` // contains filtered or unexported fields }
Details on a task in a cluster.
type TaskDefinition ¶
type TaskDefinition struct { // A list of container definitions in JSON format that describe the different // containers that make up your task. For more information about container definition // parameters and defaults, see Amazon ECS Task Definitions (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) // in the Amazon EC2 Container Service Developer Guide. ContainerDefinitions []*ContainerDefinition `locationName:"containerDefinitions" type:"list"` // The family of your task definition, used as the definition name. Family *string `locationName:"family" type:"string"` // The container instance attributes required by your task. RequiresAttributes []*Attribute `locationName:"requiresAttributes" type:"list"` // The revision of the task in a particular family. The revision is a version // number of a task definition in a family. When you register a task definition // for the first time, the revision is 1; each time you register a new revision // of a task definition in the same family, the revision value always increases // by one (even if you have deregistered previous revisions in this family). Revision *int64 `locationName:"revision" type:"integer"` // The status of the task definition. Status *string `locationName:"status" type:"string" enum:"TaskDefinitionStatus"` // The full Amazon Resource Name (ARN) of the of the task definition. TaskDefinitionArn *string `locationName:"taskDefinitionArn" type:"string"` // The list of volumes in a task. For more information about volume definition // parameters and defaults, see Amazon ECS Task Definitions (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) // in the Amazon EC2 Container Service Developer Guide. Volumes []*Volume `locationName:"volumes" type:"list"` // contains filtered or unexported fields }
Details of a task definition.
func (TaskDefinition) GoString ¶
func (s TaskDefinition) GoString() string
GoString returns the string representation
func (TaskDefinition) String ¶
func (s TaskDefinition) String() string
String returns the string representation
type TaskOverride ¶
type TaskOverride struct { // One or more container overrides sent to a task. ContainerOverrides []*ContainerOverride `locationName:"containerOverrides" type:"list"` // contains filtered or unexported fields }
The overrides associated with a task.
func (TaskOverride) GoString ¶
func (s TaskOverride) GoString() string
GoString returns the string representation
func (TaskOverride) String ¶
func (s TaskOverride) String() string
String returns the string representation
type Ulimit ¶
type Ulimit struct { // The hard limit for the ulimit type. HardLimit *int64 `locationName:"hardLimit" type:"integer" required:"true"` // The type of the ulimit. Name *string `locationName:"name" type:"string" required:"true" enum:"UlimitName"` // The soft limit for the ulimit type. SoftLimit *int64 `locationName:"softLimit" type:"integer" required:"true"` // contains filtered or unexported fields }
The ulimit settings to pass to the container.
type UpdateContainerAgentInput ¶
type UpdateContainerAgentInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster that your // container instance is running on. If you do not specify a cluster, the default // cluster is assumed. Cluster *string `locationName:"cluster" type:"string"` // The container instance ID or full Amazon Resource Name (ARN) entries for // the container instance on which you would like to update the Amazon ECS container // agent. ContainerInstance *string `locationName:"containerInstance" type:"string" required:"true"` // contains filtered or unexported fields }
func (UpdateContainerAgentInput) GoString ¶
func (s UpdateContainerAgentInput) GoString() string
GoString returns the string representation
func (UpdateContainerAgentInput) String ¶
func (s UpdateContainerAgentInput) String() string
String returns the string representation
func (*UpdateContainerAgentInput) Validate ¶
func (s *UpdateContainerAgentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateContainerAgentOutput ¶
type UpdateContainerAgentOutput struct { // An EC2 instance that is running the Amazon ECS agent and has been registered // with a cluster. ContainerInstance *ContainerInstance `locationName:"containerInstance" type:"structure"` // contains filtered or unexported fields }
func (UpdateContainerAgentOutput) GoString ¶
func (s UpdateContainerAgentOutput) GoString() string
GoString returns the string representation
func (UpdateContainerAgentOutput) String ¶
func (s UpdateContainerAgentOutput) String() string
String returns the string representation
type UpdateServiceInput ¶
type UpdateServiceInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster that your // service is running on. If you do not specify a cluster, the default cluster // is assumed. Cluster *string `locationName:"cluster" type:"string"` // Optional deployment parameters that control how many tasks run during the // deployment and the ordering of stopping and starting tasks. DeploymentConfiguration *DeploymentConfiguration `locationName:"deploymentConfiguration" type:"structure"` // The number of instantiations of the task to place and keep running in your // service. DesiredCount *int64 `locationName:"desiredCount" type:"integer"` // The name of the service to update. Service *string `locationName:"service" type:"string" required:"true"` // The family and revision (family:revision) or full Amazon Resource Name (ARN) // of the task definition to run in your service. If a revision is not specified, // the latest ACTIVE revision is used. If you modify the task definition with // UpdateService, Amazon ECS spawns a task with the new version of the task // definition and then stops an old task after the new version is running. TaskDefinition *string `locationName:"taskDefinition" type:"string"` // contains filtered or unexported fields }
func (UpdateServiceInput) GoString ¶
func (s UpdateServiceInput) GoString() string
GoString returns the string representation
func (UpdateServiceInput) String ¶
func (s UpdateServiceInput) String() string
String returns the string representation
func (*UpdateServiceInput) Validate ¶
func (s *UpdateServiceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateServiceOutput ¶
type UpdateServiceOutput struct { // The full description of your service following the update call. Service *Service `locationName:"service" type:"structure"` // contains filtered or unexported fields }
func (UpdateServiceOutput) GoString ¶
func (s UpdateServiceOutput) GoString() string
GoString returns the string representation
func (UpdateServiceOutput) String ¶
func (s UpdateServiceOutput) String() string
String returns the string representation
type VersionInfo ¶
type VersionInfo struct { // The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent // (https://github.com/aws/amazon-ecs-agent/commits/master) GitHub repository. AgentHash *string `locationName:"agentHash" type:"string"` // The version number of the Amazon ECS container agent. AgentVersion *string `locationName:"agentVersion" type:"string"` // The Docker version running on the container instance. DockerVersion *string `locationName:"dockerVersion" type:"string"` // contains filtered or unexported fields }
The Docker and Amazon ECS container agent version information about a container instance.
func (VersionInfo) GoString ¶
func (s VersionInfo) GoString() string
GoString returns the string representation
func (VersionInfo) String ¶
func (s VersionInfo) String() string
String returns the string representation
type Volume ¶
type Volume struct { // The contents of the host parameter determine whether your data volume persists // on the host container instance and where it is stored. If the host parameter // is empty, then the Docker daemon assigns a host path for your data volume, // but the data is not guaranteed to persist after the containers associated // with it stop running. Host *HostVolumeProperties `locationName:"host" type:"structure"` // The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, // hyphens, and underscores are allowed. This name is referenced in the sourceVolume // parameter of container definition mountPoints. Name *string `locationName:"name" type:"string"` // contains filtered or unexported fields }
A data volume used in a task definition.
type VolumeFrom ¶
type VolumeFrom struct { // If this value is true, the container has read-only access to the volume. // If this value is false, then the container can write to the volume. The default // value is false. ReadOnly *bool `locationName:"readOnly" type:"boolean"` // The name of the container to mount volumes from. SourceContainer *string `locationName:"sourceContainer" type:"string"` // contains filtered or unexported fields }
Details on a data volume from another container.
func (VolumeFrom) GoString ¶
func (s VolumeFrom) GoString() string
GoString returns the string representation
func (VolumeFrom) String ¶
func (s VolumeFrom) String() string
String returns the string representation