Documentation ¶
Overview ¶
Package ecs provides the client and types for making API requests to Amazon EC2 Container Service.
Amazon Elastic 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. You can host your cluster on a serverless infrastructure that is managed by Amazon ECS by launching your services or tasks using the Fargate launch type. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage by using the EC2 launch type. For more information about launch types, see Amazon ECS Launch Types (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html).
Amazon ECS lets you launch and stop container-based 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.
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 ECS eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.
See https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13 for more information on this service.
See ecs package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/ecs/
Using the Client ¶
To Amazon EC2 Container Service with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the Amazon EC2 Container Service client ECS for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/ecs/#New
Index ¶
- Constants
- type AgentUpdateStatus
- type AssignPublicIp
- type Attachment
- type AttachmentStateChange
- type Attribute
- type AwsVpcConfiguration
- type Cluster
- type ClusterField
- type Compatibility
- type Connectivity
- type Container
- type ContainerDefinition
- type ContainerInstance
- type ContainerInstanceStatus
- type ContainerOverride
- type ContainerStateChange
- type CreateClusterInput
- type CreateClusterOutput
- type CreateClusterRequest
- type CreateServiceInput
- type CreateServiceOutput
- type CreateServiceRequest
- type DeleteAttributesInput
- type DeleteAttributesOutput
- type DeleteAttributesRequest
- type DeleteClusterInput
- type DeleteClusterOutput
- type DeleteClusterRequest
- type DeleteServiceInput
- type DeleteServiceOutput
- type DeleteServiceRequest
- type Deployment
- type DeploymentConfiguration
- type DeregisterContainerInstanceInput
- type DeregisterContainerInstanceOutput
- type DeregisterContainerInstanceRequest
- type DeregisterTaskDefinitionInput
- type DeregisterTaskDefinitionOutput
- type DeregisterTaskDefinitionRequest
- type DescribeClustersInput
- type DescribeClustersOutput
- type DescribeClustersRequest
- type DescribeContainerInstancesInput
- type DescribeContainerInstancesOutput
- type DescribeContainerInstancesRequest
- type DescribeServicesInput
- type DescribeServicesOutput
- type DescribeServicesRequest
- type DescribeTaskDefinitionInput
- type DescribeTaskDefinitionOutput
- type DescribeTaskDefinitionRequest
- type DescribeTasksInput
- type DescribeTasksOutput
- type DescribeTasksRequest
- type DesiredStatus
- type Device
- type DeviceCgroupPermission
- type DiscoverPollEndpointInput
- type DiscoverPollEndpointOutput
- type DiscoverPollEndpointRequest
- type ECS
- func (c *ECS) CreateClusterRequest(input *CreateClusterInput) CreateClusterRequest
- func (c *ECS) CreateServiceRequest(input *CreateServiceInput) CreateServiceRequest
- func (c *ECS) DeleteAttributesRequest(input *DeleteAttributesInput) DeleteAttributesRequest
- func (c *ECS) DeleteClusterRequest(input *DeleteClusterInput) DeleteClusterRequest
- func (c *ECS) DeleteServiceRequest(input *DeleteServiceInput) DeleteServiceRequest
- func (c *ECS) DeregisterContainerInstanceRequest(input *DeregisterContainerInstanceInput) DeregisterContainerInstanceRequest
- func (c *ECS) DeregisterTaskDefinitionRequest(input *DeregisterTaskDefinitionInput) DeregisterTaskDefinitionRequest
- func (c *ECS) DescribeClustersRequest(input *DescribeClustersInput) DescribeClustersRequest
- func (c *ECS) DescribeContainerInstancesRequest(input *DescribeContainerInstancesInput) DescribeContainerInstancesRequest
- func (c *ECS) DescribeServicesRequest(input *DescribeServicesInput) DescribeServicesRequest
- func (c *ECS) DescribeTaskDefinitionRequest(input *DescribeTaskDefinitionInput) DescribeTaskDefinitionRequest
- func (c *ECS) DescribeTasksRequest(input *DescribeTasksInput) DescribeTasksRequest
- func (c *ECS) DiscoverPollEndpointRequest(input *DiscoverPollEndpointInput) DiscoverPollEndpointRequest
- func (c *ECS) ListAttributesRequest(input *ListAttributesInput) ListAttributesRequest
- func (c *ECS) ListClustersRequest(input *ListClustersInput) ListClustersRequest
- func (c *ECS) ListContainerInstancesRequest(input *ListContainerInstancesInput) ListContainerInstancesRequest
- func (c *ECS) ListServicesRequest(input *ListServicesInput) ListServicesRequest
- func (c *ECS) ListTaskDefinitionFamiliesRequest(input *ListTaskDefinitionFamiliesInput) ListTaskDefinitionFamiliesRequest
- func (c *ECS) ListTaskDefinitionsRequest(input *ListTaskDefinitionsInput) ListTaskDefinitionsRequest
- func (c *ECS) ListTasksRequest(input *ListTasksInput) ListTasksRequest
- func (c *ECS) PutAttributesRequest(input *PutAttributesInput) PutAttributesRequest
- func (c *ECS) RegisterContainerInstanceRequest(input *RegisterContainerInstanceInput) RegisterContainerInstanceRequest
- func (c *ECS) RegisterTaskDefinitionRequest(input *RegisterTaskDefinitionInput) RegisterTaskDefinitionRequest
- func (c *ECS) RunTaskRequest(input *RunTaskInput) RunTaskRequest
- func (c *ECS) StartTaskRequest(input *StartTaskInput) StartTaskRequest
- func (c *ECS) StopTaskRequest(input *StopTaskInput) StopTaskRequest
- func (c *ECS) SubmitContainerStateChangeRequest(input *SubmitContainerStateChangeInput) SubmitContainerStateChangeRequest
- func (c *ECS) SubmitTaskStateChangeRequest(input *SubmitTaskStateChangeInput) SubmitTaskStateChangeRequest
- func (c *ECS) UpdateContainerAgentRequest(input *UpdateContainerAgentInput) UpdateContainerAgentRequest
- func (c *ECS) UpdateContainerInstancesStateRequest(input *UpdateContainerInstancesStateInput) UpdateContainerInstancesStateRequest
- func (c *ECS) UpdateServiceRequest(input *UpdateServiceInput) UpdateServiceRequest
- func (c *ECS) WaitUntilServicesInactive(input *DescribeServicesInput) error
- func (c *ECS) WaitUntilServicesInactiveWithContext(ctx aws.Context, input *DescribeServicesInput, opts ...aws.WaiterOption) error
- func (c *ECS) WaitUntilServicesStable(input *DescribeServicesInput) error
- func (c *ECS) WaitUntilServicesStableWithContext(ctx aws.Context, input *DescribeServicesInput, opts ...aws.WaiterOption) error
- func (c *ECS) WaitUntilTasksRunning(input *DescribeTasksInput) error
- func (c *ECS) WaitUntilTasksRunningWithContext(ctx aws.Context, input *DescribeTasksInput, opts ...aws.WaiterOption) error
- func (c *ECS) WaitUntilTasksStopped(input *DescribeTasksInput) error
- func (c *ECS) WaitUntilTasksStoppedWithContext(ctx aws.Context, input *DescribeTasksInput, opts ...aws.WaiterOption) error
- type Failure
- type HealthCheck
- type HealthStatus
- type HostEntry
- type HostVolumeProperties
- type KernelCapabilities
- type KeyValuePair
- type LaunchType
- type LinuxParameters
- type ListAttributesInput
- type ListAttributesOutput
- type ListAttributesRequest
- type ListClustersInput
- type ListClustersOutput
- type ListClustersPager
- type ListClustersRequest
- type ListContainerInstancesInput
- type ListContainerInstancesOutput
- type ListContainerInstancesPager
- type ListContainerInstancesRequest
- type ListServicesInput
- type ListServicesOutput
- type ListServicesPager
- type ListServicesRequest
- type ListTaskDefinitionFamiliesInput
- type ListTaskDefinitionFamiliesOutput
- type ListTaskDefinitionFamiliesPager
- type ListTaskDefinitionFamiliesRequest
- type ListTaskDefinitionsInput
- type ListTaskDefinitionsOutput
- type ListTaskDefinitionsPager
- type ListTaskDefinitionsRequest
- type ListTasksInput
- type ListTasksOutput
- type ListTasksPager
- type ListTasksRequest
- type LoadBalancer
- type LogConfiguration
- type LogDriver
- type MountPoint
- type NetworkBinding
- type NetworkConfiguration
- type NetworkInterface
- type NetworkMode
- type PlacementConstraint
- type PlacementConstraintType
- type PlacementStrategy
- type PlacementStrategyType
- type PortMapping
- type PutAttributesInput
- type PutAttributesOutput
- type PutAttributesRequest
- type RegisterContainerInstanceInput
- type RegisterContainerInstanceOutput
- type RegisterContainerInstanceRequest
- type RegisterTaskDefinitionInput
- type RegisterTaskDefinitionOutput
- type RegisterTaskDefinitionRequest
- type Resource
- type RunTaskInput
- type RunTaskOutput
- type RunTaskRequest
- type Service
- type ServiceEvent
- type ServiceRegistry
- type SortOrder
- type StartTaskInput
- type StartTaskOutput
- type StartTaskRequest
- type StopTaskInput
- type StopTaskOutput
- type StopTaskRequest
- type SubmitContainerStateChangeInput
- type SubmitContainerStateChangeOutput
- type SubmitContainerStateChangeRequest
- type SubmitTaskStateChangeInput
- type SubmitTaskStateChangeOutput
- type SubmitTaskStateChangeRequest
- type TargetType
- type Task
- type TaskDefinition
- type TaskDefinitionFamilyStatus
- type TaskDefinitionPlacementConstraint
- type TaskDefinitionPlacementConstraintType
- type TaskDefinitionStatus
- type TaskOverride
- type Tmpfs
- type TransportProtocol
- type Ulimit
- type UlimitName
- type UpdateContainerAgentInput
- type UpdateContainerAgentOutput
- type UpdateContainerAgentRequest
- type UpdateContainerInstancesStateInput
- type UpdateContainerInstancesStateOutput
- type UpdateContainerInstancesStateRequest
- type UpdateServiceInput
- type UpdateServiceOutput
- type UpdateServiceRequest
- type VersionInfo
- type Volume
- type VolumeFrom
Examples ¶
- ECS.CreateClusterRequest (Shared00)
- ECS.CreateServiceRequest (Shared00)
- ECS.CreateServiceRequest (Shared01)
- ECS.DeleteClusterRequest (Shared00)
- ECS.DeleteServiceRequest (Shared00)
- ECS.DeregisterContainerInstanceRequest (Shared00)
- ECS.DescribeClustersRequest (Shared00)
- ECS.DescribeContainerInstancesRequest (Shared00)
- ECS.DescribeServicesRequest (Shared00)
- ECS.DescribeTaskDefinitionRequest (Shared00)
- ECS.DescribeTasksRequest (Shared00)
- ECS.ListClustersRequest (Shared00)
- ECS.ListContainerInstancesRequest (Shared00)
- ECS.ListServicesRequest (Shared00)
- ECS.ListTaskDefinitionFamiliesRequest (Shared00)
- ECS.ListTaskDefinitionFamiliesRequest (Shared01)
- ECS.ListTaskDefinitionsRequest (Shared00)
- ECS.ListTaskDefinitionsRequest (Shared01)
- ECS.ListTasksRequest (Shared00)
- ECS.ListTasksRequest (Shared01)
- ECS.RegisterTaskDefinitionRequest (Shared00)
- ECS.RunTaskRequest (Shared00)
- ECS.UpdateServiceRequest (Shared00)
- ECS.UpdateServiceRequest (Shared01)
Constants ¶
const ( // ErrCodeAccessDeniedException for service response error code // "AccessDeniedException". // // You do not have authorization to perform the requested action. ErrCodeAccessDeniedException = "AccessDeniedException" // ErrCodeAttributeLimitExceededException for service response error code // "AttributeLimitExceededException". // // You can apply up to 10 custom attributes per resource. You can view the attributes // of a resource with ListAttributes. You can remove existing attributes on // a resource with DeleteAttributes. ErrCodeAttributeLimitExceededException = "AttributeLimitExceededException" // ErrCodeBlockedException for service response error code // "BlockedException". // // Your AWS account has been blocked. Contact AWS Support (http://aws.amazon.com/contact-us/) // for more information. ErrCodeBlockedException = "BlockedException" // ErrCodeClientException for service response error code // "ClientException". // // These errors are usually caused by a client action, such as using an action // or resource on behalf of a user that doesn't have permissions to use the // action or resource, or specifying an identifier that is not valid. ErrCodeClientException = "ClientException" // ErrCodeClusterContainsContainerInstancesException for service response error code // "ClusterContainsContainerInstancesException". // // You cannot delete a cluster that has registered container instances. You // must first deregister the container instances before you can delete the cluster. // For more information, see DeregisterContainerInstance. ErrCodeClusterContainsContainerInstancesException = "ClusterContainsContainerInstancesException" // ErrCodeClusterContainsServicesException for service response error code // "ClusterContainsServicesException". // // You cannot delete a cluster that contains services. You must first update // the service to reduce its desired task count to 0 and then delete the service. // For more information, see UpdateService and DeleteService. ErrCodeClusterContainsServicesException = "ClusterContainsServicesException" // ErrCodeClusterContainsTasksException for service response error code // "ClusterContainsTasksException". // // You cannot delete a cluster that has active tasks. ErrCodeClusterContainsTasksException = "ClusterContainsTasksException" // ErrCodeClusterNotFoundException for service response error code // "ClusterNotFoundException". // // The specified cluster could not be found. You can view your available clusters // with ListClusters. Amazon ECS clusters are region-specific. ErrCodeClusterNotFoundException = "ClusterNotFoundException" // ErrCodeInvalidParameterException for service response error code // "InvalidParameterException". // // The specified parameter is invalid. Review the available parameters for the // API request. ErrCodeInvalidParameterException = "InvalidParameterException" // ErrCodeMissingVersionException for service response error code // "MissingVersionException". // // Amazon ECS is unable to determine the current version of the Amazon ECS container // agent on the container instance and does not have enough information to proceed // with an update. This could be because the agent running on the container // instance is an older or custom version that does not use our version information. ErrCodeMissingVersionException = "MissingVersionException" // ErrCodeNoUpdateAvailableException for service response error code // "NoUpdateAvailableException". // // There is no update available for this Amazon ECS container agent. This could // be because the agent is already running the latest version, or it is so old // that there is no update path to the current version. ErrCodeNoUpdateAvailableException = "NoUpdateAvailableException" // ErrCodePlatformTaskDefinitionIncompatibilityException for service response error code // "PlatformTaskDefinitionIncompatibilityException". // // The specified platform version does not satisfy the task definition’s required // capabilities. ErrCodePlatformTaskDefinitionIncompatibilityException = "PlatformTaskDefinitionIncompatibilityException" // ErrCodePlatformUnknownException for service response error code // "PlatformUnknownException". // // The specified platform version does not exist. ErrCodePlatformUnknownException = "PlatformUnknownException" // ErrCodeServerException for service response error code // "ServerException". // // These errors are usually caused by a server issue. ErrCodeServerException = "ServerException" // ErrCodeServiceNotActiveException for service response error code // "ServiceNotActiveException". // // The specified service is not active. You can't update a service that is inactive. // If you have previously deleted a service, you can re-create it with CreateService. ErrCodeServiceNotActiveException = "ServiceNotActiveException" // ErrCodeServiceNotFoundException for service response error code // "ServiceNotFoundException". // // The specified service could not be found. You can view your available services // with ListServices. Amazon ECS services are cluster-specific and region-specific. ErrCodeServiceNotFoundException = "ServiceNotFoundException" // ErrCodeTargetNotFoundException for service response error code // "TargetNotFoundException". // // The specified target could not be found. You can view your available container // instances with ListContainerInstances. Amazon ECS container instances are // cluster-specific and region-specific. ErrCodeTargetNotFoundException = "TargetNotFoundException" // ErrCodeUnsupportedFeatureException for service response error code // "UnsupportedFeatureException". // // The specified task is not supported in this region. ErrCodeUnsupportedFeatureException = "UnsupportedFeatureException" // ErrCodeUpdateInProgressException for service response error code // "UpdateInProgressException". // // There is already a current Amazon ECS container agent update in progress // on the specified container instance. If the container agent becomes disconnected // while it is in a transitional stage, such as PENDING or STAGING, the update // process can get stuck in that state. However, when the agent reconnects, // it resumes where it stopped previously. ErrCodeUpdateInProgressException = "UpdateInProgressException" )
const ( ServiceName = "ecs" // Service endpoint prefix API calls made to. EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata. )
Service information constants
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AgentUpdateStatus ¶
type AgentUpdateStatus string
const ( AgentUpdateStatusPending AgentUpdateStatus = "PENDING" AgentUpdateStatusStaging AgentUpdateStatus = "STAGING" AgentUpdateStatusStaged AgentUpdateStatus = "STAGED" AgentUpdateStatusUpdating AgentUpdateStatus = "UPDATING" AgentUpdateStatusUpdated AgentUpdateStatus = "UPDATED" AgentUpdateStatusFailed AgentUpdateStatus = "FAILED" )
Enum values for AgentUpdateStatus
func (AgentUpdateStatus) MarshalValue ¶
func (enum AgentUpdateStatus) MarshalValue() (string, error)
func (AgentUpdateStatus) MarshalValueBuf ¶
func (enum AgentUpdateStatus) MarshalValueBuf(b []byte) ([]byte, error)
type AssignPublicIp ¶
type AssignPublicIp string
const ( AssignPublicIpEnabled AssignPublicIp = "ENABLED" AssignPublicIpDisabled AssignPublicIp = "DISABLED" )
Enum values for AssignPublicIp
func (AssignPublicIp) MarshalValue ¶
func (enum AssignPublicIp) MarshalValue() (string, error)
func (AssignPublicIp) MarshalValueBuf ¶
func (enum AssignPublicIp) MarshalValueBuf(b []byte) ([]byte, error)
type Attachment ¶
type Attachment struct { // Details of the attachment. For Elastic Network Interfaces, this includes // the network interface ID, the MAC address, the subnet ID, and the private // IPv4 address. Details []KeyValuePair `locationName:"details" type:"list"` // The unique identifier for the attachment. Id *string `locationName:"id" type:"string"` // The status of the attachment. Valid values are PRECREATED, CREATED, ATTACHING, // ATTACHED, DETACHING, DETACHED, and DELETED. Status *string `locationName:"status" type:"string"` // The type of the attachment, such as ElasticNetworkInterface. Type *string `locationName:"type" type:"string"` // contains filtered or unexported fields }
An object representing a container instance or task attachment. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/Attachment
func (Attachment) GoString ¶
func (s Attachment) GoString() string
GoString returns the string representation
func (Attachment) String ¶
func (s Attachment) String() string
String returns the string representation
type AttachmentStateChange ¶
type AttachmentStateChange struct { // The Amazon Resource Name (ARN) of the attachment. // // AttachmentArn is a required field AttachmentArn *string `locationName:"attachmentArn" type:"string" required:"true"` // The status of the attachment. // // Status is a required field Status *string `locationName:"status" type:"string" required:"true"` // contains filtered or unexported fields }
An object representing a change in state for a task attachment. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/AttachmentStateChange
func (AttachmentStateChange) GoString ¶
func (s AttachmentStateChange) GoString() string
GoString returns the string representation
func (AttachmentStateChange) String ¶
func (s AttachmentStateChange) String() string
String returns the string representation
func (*AttachmentStateChange) Validate ¶
func (s *AttachmentStateChange) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Attribute ¶
type Attribute struct { // The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers, // hyphens, underscores, and periods are allowed. // // Name is a required field Name *string `locationName:"name" type:"string" required:"true"` // The ID of the target. You can specify the short form ID for a resource or // the full Amazon Resource Name (ARN). TargetId *string `locationName:"targetId" type:"string"` // The type of the target with which to attach the attribute. This parameter // is required if you use the short form ID for a resource instead of the full // ARN. TargetType TargetType `locationName:"targetType" type:"string" enum:"true"` // The value of the attribute. Up to 128 letters (uppercase and lowercase), // numbers, hyphens, underscores, periods, at signs (@), forward slashes, colons, // and spaces are allowed. Value *string `locationName:"value" type:"string"` // contains filtered or unexported fields }
An attribute is a name-value pair associated with an Amazon ECS object. Attributes enable you to extend the Amazon ECS data model by adding custom metadata to your resources. For more information, see Attributes (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes) in the Amazon Elastic Container Service Developer Guide. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/Attribute
type AwsVpcConfiguration ¶
type AwsVpcConfiguration struct { // Whether the task's elastic network interface receives a public IP address. AssignPublicIp AssignPublicIp `locationName:"assignPublicIp" type:"string" enum:"true"` // The security groups associated with the task or service. If you do not specify // a security group, the default security group for the VPC is used. There is // a limit of 5 security groups able to be specified per AwsVpcConfiguration. SecurityGroups []string `locationName:"securityGroups" type:"list"` // The subnets associated with the task or service. There is a limit of 10 subnets // able to be specified per AwsVpcConfiguration. // // Subnets is a required field Subnets []string `locationName:"subnets" type:"list" required:"true"` // contains filtered or unexported fields }
An object representing the networking details for a task or service. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/AwsVpcConfiguration
func (AwsVpcConfiguration) GoString ¶
func (s AwsVpcConfiguration) GoString() string
GoString returns the string representation
func (AwsVpcConfiguration) String ¶
func (s AwsVpcConfiguration) String() string
String returns the string representation
func (*AwsVpcConfiguration) Validate ¶
func (s *AwsVpcConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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"` // Additional information about your clusters that are separated by launch type, // including: // // * runningEC2TasksCount // // * RunningFargateTasksCount // // * pendingEC2TasksCount // // * pendingFargateTasksCount // // * activeEC2ServiceCount // // * activeFargateServiceCount // // * drainingEC2ServiceCount // // * drainingFargateServiceCount Statistics []KeyValuePair `locationName:"statistics" type:"list"` // 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/Cluster
type ClusterField ¶
type ClusterField string
const (
ClusterFieldStatistics ClusterField = "STATISTICS"
)
Enum values for ClusterField
func (ClusterField) MarshalValue ¶
func (enum ClusterField) MarshalValue() (string, error)
func (ClusterField) MarshalValueBuf ¶
func (enum ClusterField) MarshalValueBuf(b []byte) ([]byte, error)
type Compatibility ¶
type Compatibility string
const ( CompatibilityEc2 Compatibility = "EC2" CompatibilityFargate Compatibility = "FARGATE" )
Enum values for Compatibility
func (Compatibility) MarshalValue ¶
func (enum Compatibility) MarshalValue() (string, error)
func (Compatibility) MarshalValueBuf ¶
func (enum Compatibility) MarshalValueBuf(b []byte) ([]byte, error)
type Connectivity ¶
type Connectivity string
const ( ConnectivityConnected Connectivity = "CONNECTED" ConnectivityDisconnected Connectivity = "DISCONNECTED" )
Enum values for Connectivity
func (Connectivity) MarshalValue ¶
func (enum Connectivity) MarshalValue() (string, error)
func (Connectivity) MarshalValueBuf ¶
func (enum Connectivity) MarshalValueBuf(b []byte) ([]byte, error)
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 health status of the container. If health checks are not configured for // this container in its task definition, then it reports health status as UNKNOWN. HealthStatus HealthStatus `locationName:"healthStatus" type:"string" enum:"true"` // 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"` // The network interfaces associated with the container. NetworkInterfaces []NetworkInterface `locationName:"networkInterfaces" type:"list"` // A short (255 max characters) human-readable string to provide additional // details about a running or stopped container. Reason *string `locationName:"reason" type:"string"` // The ARN of the task. TaskArn *string `locationName:"taskArn" type:"string"` // contains filtered or unexported fields }
A Docker container that is part of a task. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/Container
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/engine/reference/api/docker_remote_api_v1.27/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the COMMAND parameter to docker run (https://docs.docker.com/engine/reference/run/). // For more information, see https://docs.docker.com/engine/reference/builder/#cmd // (https://docs.docker.com/engine/reference/builder/#cmd). Command []string `locationName:"command" type:"list"` // The number of cpu units reserved for the container. This parameter maps to // CpuShares in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --cpu-shares option to docker run (https://docs.docker.com/engine/reference/run/). // // This field is optional for tasks using the Fargate launch type, and the only // requirement is that the total amount of CPU reserved for all containers within // a task be lower than the task-level cpu value. // // 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. // // Linux containers share unallocated CPU units with other containers on the // container instance with the same ratio as their allocated amount. 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. // // On Linux container instances, 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/engine/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. // // On Windows container instances, the CPU limit is enforced as an absolute // limit, or a quota. Windows containers only have access to the specified amount // of CPU that is described in the task definition. 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/engine/reference/api/docker_remote_api_v1.27/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/). // // This parameter is not supported for Windows containers. 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/engine/reference/api/docker_remote_api_v1.27/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --dns-search option to docker run (https://docs.docker.com/engine/reference/run/). // // This parameter is not supported for Windows containers. 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/engine/reference/api/docker_remote_api_v1.27/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --dns option to docker run (https://docs.docker.com/engine/reference/run/). // // This parameter is not supported for Windows containers. 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/engine/reference/api/docker_remote_api_v1.27/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --label option to docker run (https://docs.docker.com/engine/reference/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 in to 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 field is not valid for containers in tasks using the // Fargate launch type. // // This parameter maps to SecurityOpt in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --security-opt option to docker run (https://docs.docker.com/engine/reference/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/ecs-agent-config.html) // in the Amazon Elastic Container Service Developer Guide. // // This parameter is not supported for Windows containers. 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/engine/reference/api/docker_remote_api_v1.27/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --entrypoint option to docker run (https://docs.docker.com/engine/reference/run/). // For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint // (https://docs.docker.com/engine/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/engine/reference/api/docker_remote_api_v1.27/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --env option to docker run (https://docs.docker.com/engine/reference/run/). // // We do not recommend using plaintext 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, and that container // fails or stops for any reason, all other containers that are part of the // task are stopped. 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. If you have an application // that is composed of multiple containers, you should group containers that // are used for a common purpose into components, and separate the different // components into multiple task definitions. For more information, see Application // Architecture (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html) // in the Amazon Elastic Container Service Developer Guide. Essential *bool `locationName:"essential" type:"boolean"` // A list of hostnames and IP address mappings to append to the /etc/hosts file // on the container. If using the Fargate launch type, this may be used to list // non-Fargate hosts you want the container to talk to. This parameter maps // to ExtraHosts in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --add-host option to docker run (https://docs.docker.com/engine/reference/run/). // // This parameter is not supported for Windows containers. ExtraHosts []HostEntry `locationName:"extraHosts" type:"list"` // The health check command and associated configuration parameters for the // container. This parameter maps to HealthCheck in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the HEALTHCHECK parameter of docker run (https://docs.docker.com/engine/reference/run/). HealthCheck *HealthCheck `locationName:"healthCheck" type:"structure"` // The hostname to use for your container. This parameter maps to Hostname in // the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --hostname option to docker run (https://docs.docker.com/engine/reference/run/). // // The hostname parameter is not supported if using the awsvpc networkMode. 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 either repository-url/image:tag or // repository-url/image@digest. 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/engine/reference/api/docker_remote_api_v1.27/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the IMAGE parameter of docker run (https://docs.docker.com/engine/reference/run/). // // * When a new task starts, the Amazon ECS container agent pulls the latest // version of the specified image and tag for the container to use. However, // subsequent updates to a repository image are not propagated to already // running tasks. // // * Images in Amazon ECR repositories can be specified by either using the // full registry/repository:tag or registry/repository@digest. For example, // 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest // or 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE. // // // * 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. Only supported if the network mode of a task // definition is set to bridge. The name:internalName construct is analogous // to name:alias in Docker links. Up to 255 letters (uppercase and lowercase), // numbers, hyphens, and underscores are allowed. For more information about // linking Docker containers, go to https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/ // (https://docs.docker.com/engine/userguide/networking/default_network/dockerlinks/). // This parameter maps to Links in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --link option to docker run (https://docs.docker.com/engine/reference/commandline/run/). // // This parameter is not supported for Windows containers. // // 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"` // Linux-specific modifications that are applied to the container, such as Linux // KernelCapabilities. // // This parameter is not supported for Windows containers. LinuxParameters *LinuxParameters `locationName:"linuxParameters" type:"structure"` // The log configuration specification for the container. // // If using the Fargate launch type, the only supported value is awslogs. // // This parameter maps to LogConfig in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --log-driver option to docker run (https://docs.docker.com/engine/reference/run/). // By default, containers use the same logging driver that the Docker daemon // uses; however the container may use a different logging driver than the Docker // daemon by specifying a log driver with this parameter in the container definition. // To use a different logging driver for a container, the log system must be // configured properly on the container instance (or on a different log server // for remote logging options). For more information on the options for different // supported log drivers, see Configure logging drivers (https://docs.docker.com/engine/admin/logging/overview/) // in the Docker documentation. // // Amazon ECS currently supports a subset of the logging drivers available to // the Docker daemon (shown in the LogConfiguration data type). Additional log // drivers may be available in future releases of the Amazon ECS container agent. // // 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 in to 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/ecs-agent-config.html) // in the Amazon Elastic Container Service Developer Guide. LogConfiguration *LogConfiguration `locationName:"logConfiguration" type:"structure"` // The hard limit (in MiB) of memory to present to the container. If your container // attempts to exceed the memory specified here, the container is killed. This // parameter maps to Memory in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --memory option to docker run (https://docs.docker.com/engine/reference/run/). // // If your containers are part of a task using the Fargate launch type, this // field is optional and the only requirement is that the total amount of memory // reserved for all containers within a task be lower than the task memory value. // // For containers that are part of a task using the EC2 launch type, you must // specify a non-zero integer for one or both of memory or memoryReservation // in container definitions. If you specify both, memory must be greater than // memoryReservation. If you specify memoryReservation, then that value is subtracted // from the available memory resources for the container instance on which the // container is placed; otherwise, the value of memory is used. // // 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. Memory *int64 `locationName:"memory" type:"integer"` // The soft limit (in MiB) of memory to reserve for the container. When system // memory is under heavy contention, Docker attempts to keep the container memory // to this soft limit; however, your container can consume more memory when // it needs to, up to either the hard limit specified with the memory parameter // (if applicable), or all of the available memory on the container instance, // whichever comes first. This parameter maps to MemoryReservation in the Create // a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --memory-reservation option to docker run (https://docs.docker.com/engine/reference/run/). // // You must specify a non-zero integer for one or both of memory or memoryReservation // in container definitions. If you specify both, memory must be greater than // memoryReservation. If you specify memoryReservation, then that value is subtracted // from the available memory resources for the container instance on which the // container is placed; otherwise, the value of memory is used. // // For example, if your container normally uses 128 MiB of memory, but occasionally // bursts to 256 MiB of memory for short periods of time, you can set a memoryReservation // of 128 MiB, and a memory hard limit of 300 MiB. This configuration would // allow the container to only reserve 128 MiB of memory from the remaining // resources on the container instance, but also allow the container to consume // more memory resources when needed. // // 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. MemoryReservation *int64 `locationName:"memoryReservation" 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/engine/reference/api/docker_remote_api_v1.27/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --volume option to docker run (https://docs.docker.com/engine/reference/run/). // // Windows containers can mount whole directories on the same drive as $env:ProgramData. // Windows containers cannot mount directories on a different drive, and mount // point cannot be across drives. 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/engine/reference/api/docker_remote_api_v1.27/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --name option to docker run (https://docs.docker.com/engine/reference/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. // // For task definitions that use the awsvpc network mode, you should only specify // the containerPort. The hostPort can be left blank or it must be the same // value as the containerPort. // // Port mappings on Windows use the NetNAT gateway address rather than localhost. // There is no loopback for port mappings on Windows, so you cannot access a // container's mapped port from the host itself. // // This parameter maps to PortBindings in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --publish option to docker run (https://docs.docker.com/engine/reference/run/). // If the network mode of a task definition is set to none, then you can't specify // port mappings. If the network mode of a task definition is set to host, then // host ports must either be undefined or they must match the container port // in the port mapping. // // 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 for 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/engine/reference/api/docker_remote_api_v1.27/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --privileged option to docker run (https://docs.docker.com/engine/reference/run/). // // This parameter is not supported for Windows containers or tasks using the // Fargate launch type. 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/engine/reference/api/docker_remote_api_v1.27/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --read-only option to docker run. // // This parameter is not supported for Windows containers. 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/engine/reference/api/docker_remote_api_v1.27/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --ulimit option to docker run (https://docs.docker.com/engine/reference/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 in to your container instance and run the following command: sudo docker // version | grep "Server API version" // // This parameter is not supported for Windows containers. 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/engine/reference/api/docker_remote_api_v1.27/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --user option to docker run (https://docs.docker.com/engine/reference/run/). // // This parameter is not supported for Windows containers. 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/engine/reference/api/docker_remote_api_v1.27/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --volumes-from option to docker run (https://docs.docker.com/engine/reference/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/engine/reference/api/docker_remote_api_v1.27/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --workdir option to docker run (https://docs.docker.com/engine/reference/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. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ContainerDefinition
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 connected to Amazon ECS. Registered // instances with an agent that may be unhealthy or stopped return false. Instances // without a connected agent can't 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 AgentUpdateStatus `locationName:"agentUpdateStatus" type:"string" enum:"true"` // The Elastic Network Interfaces associated with the container instance. Attachments []Attachment `locationName:"attachments" type:"list"` // The attributes set for the container instance, either by the Amazon ECS container // agent at instance registration or manually with the PutAttributes operation. 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 Unix time stamp for when the container instance was registered. RegisteredAt *time.Time `locationName:"registeredAt" type:"timestamp" timestampFormat:"unix"` // For CPU and memory resource types, this parameter describes the amount of // each resource that was available on the container instance when the container // agent registered it with Amazon ECS; this value represents the total amount // of CPU and memory that can be allocated on this container instance to tasks. // For port resource types, this parameter describes the ports that were reserved // by the Amazon ECS container agent when it registered the container instance // with Amazon ECS. RegisteredResources []Resource `locationName:"registeredResources" type:"list"` // For CPU and memory resource types, this parameter describes the remaining // CPU and memory that has not already been allocated to tasks and is therefore // available for new tasks. For port resource types, this parameter describes // the ports that were reserved by the Amazon ECS container agent (at instance // registration time) and any task containers that have reserved port mappings // on the host (with the host or bridge network mode). Any port that is not // specified here is 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, INACTIVE, // or DRAINING. ACTIVE indicates that the container instance can accept tasks. // DRAINING indicates that new tasks are not placed on the container instance // and any service tasks running on the container instance are removed if possible. // For more information, see Container Instance Draining (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/container-instance-draining.html) // in the Amazon Elastic Container Service Developer Guide. Status *string `locationName:"status" type:"string"` // The version counter for the container instance. Every time a container instance // experiences a change that triggers a CloudWatch event, the version counter // is incremented. If you are replicating your Amazon ECS container instance // state with CloudWatch Events, you can compare the version of a container // instance reported by the Amazon ECS APIs with the version reported in CloudWatch // Events for the container instance (inside the detail object) to verify that // the version in your event stream is current. Version *int64 `locationName:"version" type:"long"` // 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ContainerInstance
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 ContainerInstanceStatus ¶
type ContainerInstanceStatus string
const ( ContainerInstanceStatusActive ContainerInstanceStatus = "ACTIVE" ContainerInstanceStatusDraining ContainerInstanceStatus = "DRAINING" )
Enum values for ContainerInstanceStatus
func (ContainerInstanceStatus) MarshalValue ¶
func (enum ContainerInstanceStatus) MarshalValue() (string, error)
func (ContainerInstanceStatus) MarshalValueBuf ¶
func (enum ContainerInstanceStatus) MarshalValueBuf(b []byte) ([]byte, error)
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. You must also specify a container // name. Command []string `locationName:"command" type:"list"` // The number of cpu units reserved for the container, instead of the default // value from the task definition. You must also specify a container name. Cpu *int64 `locationName:"cpu" type:"integer"` // 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. // You must also specify a container name. Environment []KeyValuePair `locationName:"environment" type:"list"` // The hard limit (in MiB) of memory to present to the container, instead of // the default value from the task definition. If your container attempts to // exceed the memory specified here, the container is killed. You must also // specify a container name. Memory *int64 `locationName:"memory" type:"integer"` // The soft limit (in MiB) of memory to reserve for the container, instead of // the default value from the task definition. You must also specify a container // name. MemoryReservation *int64 `locationName:"memoryReservation" type:"integer"` // The name of the container that receives the override. This parameter is required // if any override is specified. Name *string `locationName:"name" type:"string"` // contains filtered or unexported fields }
The overrides that should be sent to a container. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ContainerOverride
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 ContainerStateChange ¶
type ContainerStateChange struct { // The name of the container. ContainerName *string `locationName:"containerName" type:"string"` // The exit code for the container, if the state change is a result of the container // exiting. ExitCode *int64 `locationName:"exitCode" type:"integer"` // Any network bindings associated with the container. NetworkBindings []NetworkBinding `locationName:"networkBindings" type:"list"` // The reason for the state change. Reason *string `locationName:"reason" type:"string"` // The status of the container. Status *string `locationName:"status" type:"string"` // contains filtered or unexported fields }
An object representing a change in state for a container. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ContainerStateChange
func (ContainerStateChange) GoString ¶
func (s ContainerStateChange) GoString() string
GoString returns the string representation
func (ContainerStateChange) String ¶
func (s ContainerStateChange) 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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateClusterRequest
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateClusterResponse
func (CreateClusterOutput) GoString ¶
func (s CreateClusterOutput) GoString() string
GoString returns the string representation
func (CreateClusterOutput) SDKResponseMetadata ¶
func (s CreateClusterOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (CreateClusterOutput) String ¶
func (s CreateClusterOutput) String() string
String returns the string representation
type CreateClusterRequest ¶
type CreateClusterRequest struct { *aws.Request Input *CreateClusterInput Copy func(*CreateClusterInput) CreateClusterRequest }
CreateClusterRequest is a API request type for the CreateCluster API operation.
func (CreateClusterRequest) Send ¶
func (r CreateClusterRequest) Send() (*CreateClusterOutput, error)
Send marshals and sends the CreateCluster API request.
type CreateServiceInput ¶
type CreateServiceInput struct { // Unique, case-sensitive identifier that 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 is a required field DesiredCount *int64 `locationName:"desiredCount" type:"integer" required:"true"` // The period of time, in seconds, that the Amazon ECS service scheduler should // ignore unhealthy Elastic Load Balancing target health checks after a task // has first started. This is only valid if your service is configured to use // a load balancer. If your service's tasks take a while to start and respond // to Elastic Load Balancing health checks, you can specify a health check grace // period of up to 1,800 seconds during which the ECS service scheduler ignores // health check status. This grace period can prevent the ECS service scheduler // from marking tasks as unhealthy and stopping them before they have time to // come up. HealthCheckGracePeriodSeconds *int64 `locationName:"healthCheckGracePeriodSeconds" type:"integer"` // The launch type on which to run your service. LaunchType LaunchType `locationName:"launchType" type:"string" enum:"true"` // A load balancer object representing the load balancer to use with your service. // Currently, you are limited to one load balancer or target group per service. // After you create a service, the load balancer name or target group ARN, container // name, and container port specified in the service definition are immutable. // // For Classic Load Balancers, this object must contain the load balancer name, // the container name (as it appears in a container definition), and the container // port to access from the load balancer. When a task from this service is placed // on a container instance, the container instance is registered with the load // balancer specified here. // // For Application Load Balancers and Network Load Balancers, this object must // contain the load balancer target group ARN, the container name (as it appears // in a container definition), and the container port to access from the load // balancer. When a task from this service is placed on a container instance, // the container instance and port combination is registered as a target in // the target group specified here. // // Services with tasks that use the awsvpc network mode (for example, those // with the Fargate launch type) only support Application Load Balancers and // Network Load Balancers; Classic Load Balancers are not supported. Also, when // you create any target groups for these services, you must choose ip as the // target type, not instance, because tasks that use the awsvpc network mode // are associated with an elastic network interface, not an Amazon EC2 instance. LoadBalancers []LoadBalancer `locationName:"loadBalancers" type:"list"` // The network configuration for the service. This parameter is required for // task definitions that use the awsvpc network mode to receive their own Elastic // Network Interface, and it is not supported for other network modes. For more // information, see Task Networking (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) // in the Amazon Elastic Container Service Developer Guide. NetworkConfiguration *NetworkConfiguration `locationName:"networkConfiguration" type:"structure"` // An array of placement constraint objects to use for tasks in your service. // You can specify a maximum of 10 constraints per task (this limit includes // constraints in the task definition and those specified at run time). PlacementConstraints []PlacementConstraint `locationName:"placementConstraints" type:"list"` // The placement strategy objects to use for tasks in your service. You can // specify a maximum of five strategy rules per service. PlacementStrategy []PlacementStrategy `locationName:"placementStrategy" type:"list"` // The platform version on which to run your service. If one is not specified, // the latest version is used by default. PlatformVersion *string `locationName:"platformVersion" type:"string"` // The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon // ECS to make calls to your load balancer on your behalf. This parameter is // only permitted if you are using a load balancer with your service and your // task definition does not use the awsvpc network mode. If you specify the // role parameter, you must also specify a load balancer object with the loadBalancers // parameter. // // If your account has already created the Amazon ECS service-linked role, that // role is used by default for your service unless you specify a role here. // The service-linked role is required if your task definition uses the awsvpc // network mode, in which case you should not specify a role here. For more // information, see Using Service-Linked Roles for Amazon ECS (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) // in the Amazon Elastic Container Service Developer Guide. // // If your specified role has a path other than /, then you must either specify // the full role ARN (this is recommended) or prefix the role name with the // path. For example, if a role with the name bar has a path of /foo/ then you // would specify /foo/bar as the role name. For more information, see Friendly // Names and Paths (http://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) // in the IAM User Guide. 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 is a required field ServiceName *string `locationName:"serviceName" type:"string" required:"true"` // The details of the service discovery registries you want to assign to this // service. For more information, see Service Discovery (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html). // // Service discovery is supported for Fargate tasks if using platform version // v1.1.0 or later. For more information, see AWS Fargate Platform Versions // (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html). ServiceRegistries []ServiceRegistry `locationName:"serviceRegistries" type:"list"` // The family and revision (family:revision) or full ARN of the task definition // to run in your service. If a revision is not specified, the latest ACTIVE // revision is used. // // TaskDefinition is a required field TaskDefinition *string `locationName:"taskDefinition" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateServiceRequest
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateServiceResponse
func (CreateServiceOutput) GoString ¶
func (s CreateServiceOutput) GoString() string
GoString returns the string representation
func (CreateServiceOutput) SDKResponseMetadata ¶
func (s CreateServiceOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (CreateServiceOutput) String ¶
func (s CreateServiceOutput) String() string
String returns the string representation
type CreateServiceRequest ¶
type CreateServiceRequest struct { *aws.Request Input *CreateServiceInput Copy func(*CreateServiceInput) CreateServiceRequest }
CreateServiceRequest is a API request type for the CreateService API operation.
func (CreateServiceRequest) Send ¶
func (r CreateServiceRequest) Send() (*CreateServiceOutput, error)
Send marshals and sends the CreateService API request.
type DeleteAttributesInput ¶
type DeleteAttributesInput struct { // The attributes to delete from your resource. You can specify up to 10 attributes // per request. For custom attributes, specify the attribute name and target // ID, but do not specify the value. If you specify the target ID using the // short form, you must also specify the target type. // // Attributes is a required field Attributes []Attribute `locationName:"attributes" type:"list" required:"true"` // The short name or full Amazon Resource Name (ARN) of the cluster that contains // the resource to delete attributes. If you do not specify a cluster, the default // cluster is assumed. Cluster *string `locationName:"cluster" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteAttributesRequest
func (DeleteAttributesInput) GoString ¶
func (s DeleteAttributesInput) GoString() string
GoString returns the string representation
func (DeleteAttributesInput) String ¶
func (s DeleteAttributesInput) String() string
String returns the string representation
func (*DeleteAttributesInput) Validate ¶
func (s *DeleteAttributesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteAttributesOutput ¶
type DeleteAttributesOutput struct { // A list of attribute objects that were successfully deleted from your resource. Attributes []Attribute `locationName:"attributes" type:"list"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteAttributesResponse
func (DeleteAttributesOutput) GoString ¶
func (s DeleteAttributesOutput) GoString() string
GoString returns the string representation
func (DeleteAttributesOutput) SDKResponseMetadata ¶
func (s DeleteAttributesOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DeleteAttributesOutput) String ¶
func (s DeleteAttributesOutput) String() string
String returns the string representation
type DeleteAttributesRequest ¶
type DeleteAttributesRequest struct { *aws.Request Input *DeleteAttributesInput Copy func(*DeleteAttributesInput) DeleteAttributesRequest }
DeleteAttributesRequest is a API request type for the DeleteAttributes API operation.
func (DeleteAttributesRequest) Send ¶
func (r DeleteAttributesRequest) Send() (*DeleteAttributesOutput, error)
Send marshals and sends the DeleteAttributes API request.
type DeleteClusterInput ¶
type DeleteClusterInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster to delete. // // Cluster is a required field Cluster *string `locationName:"cluster" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteClusterRequest
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteClusterResponse
func (DeleteClusterOutput) GoString ¶
func (s DeleteClusterOutput) GoString() string
GoString returns the string representation
func (DeleteClusterOutput) SDKResponseMetadata ¶
func (s DeleteClusterOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DeleteClusterOutput) String ¶
func (s DeleteClusterOutput) String() string
String returns the string representation
type DeleteClusterRequest ¶
type DeleteClusterRequest struct { *aws.Request Input *DeleteClusterInput Copy func(*DeleteClusterInput) DeleteClusterRequest }
DeleteClusterRequest is a API request type for the DeleteCluster API operation.
func (DeleteClusterRequest) Send ¶
func (r DeleteClusterRequest) Send() (*DeleteClusterOutput, error)
Send marshals and sends the DeleteCluster API request.
type DeleteServiceInput ¶
type DeleteServiceInput struct { // The short name or full Amazon Resource Name (ARN) 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 is a required field Service *string `locationName:"service" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteServiceRequest
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteServiceResponse
func (DeleteServiceOutput) GoString ¶
func (s DeleteServiceOutput) GoString() string
GoString returns the string representation
func (DeleteServiceOutput) SDKResponseMetadata ¶
func (s DeleteServiceOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DeleteServiceOutput) String ¶
func (s DeleteServiceOutput) String() string
String returns the string representation
type DeleteServiceRequest ¶
type DeleteServiceRequest struct { *aws.Request Input *DeleteServiceInput Copy func(*DeleteServiceInput) DeleteServiceRequest }
DeleteServiceRequest is a API request type for the DeleteService API operation.
func (DeleteServiceRequest) Send ¶
func (r DeleteServiceRequest) Send() (*DeleteServiceOutput, error)
Send marshals and sends the DeleteService API request.
type Deployment ¶
type Deployment struct { // The Unix time stamp for 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 launch type on which your service is running. LaunchType LaunchType `locationName:"launchType" type:"string" enum:"true"` // The VPC subnet and security group configuration for tasks that receive their // own Elastic Network Interface by using the awsvpc networking mode. NetworkConfiguration *NetworkConfiguration `locationName:"networkConfiguration" type:"structure"` // The number of tasks in the deployment that are in the PENDING status. PendingCount *int64 `locationName:"pendingCount" type:"integer"` // The platform version on which your service is running. PlatformVersion *string `locationName:"platformVersion" type:"string"` // 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 stamp for 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/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 tasks that are allowed in the RUNNING or PENDING state in a service during // a deployment. The maximum number of tasks during a deployment is the desiredCount // multiplied by 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 in the RUNNING state in a service during // a deployment. The minimum number of healthy tasks during a deployment is // the desiredCount multiplied by 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeploymentConfiguration
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 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 is a required field 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 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. // // Any containers in orphaned service tasks that are registered with a Classic // Load Balancer or an Application Load Balancer target group are deregistered. // They begin connection draining according to the settings on the load balancer // or target group. Force *bool `locationName:"force" type:"boolean"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeregisterContainerInstanceRequest
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 { // The container instance that was deregistered. ContainerInstance *ContainerInstance `locationName:"containerInstance" type:"structure"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeregisterContainerInstanceResponse
func (DeregisterContainerInstanceOutput) GoString ¶
func (s DeregisterContainerInstanceOutput) GoString() string
GoString returns the string representation
func (DeregisterContainerInstanceOutput) SDKResponseMetadata ¶
func (s DeregisterContainerInstanceOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DeregisterContainerInstanceOutput) String ¶
func (s DeregisterContainerInstanceOutput) String() string
String returns the string representation
type DeregisterContainerInstanceRequest ¶
type DeregisterContainerInstanceRequest struct { *aws.Request Input *DeregisterContainerInstanceInput Copy func(*DeregisterContainerInstanceInput) DeregisterContainerInstanceRequest }
DeregisterContainerInstanceRequest is a API request type for the DeregisterContainerInstance API operation.
func (DeregisterContainerInstanceRequest) Send ¶
func (r DeregisterContainerInstanceRequest) Send() (*DeregisterContainerInstanceOutput, error)
Send marshals and sends the DeregisterContainerInstance API request.
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 is a required field TaskDefinition *string `locationName:"taskDefinition" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeregisterTaskDefinitionRequest
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeregisterTaskDefinitionResponse
func (DeregisterTaskDefinitionOutput) GoString ¶
func (s DeregisterTaskDefinitionOutput) GoString() string
GoString returns the string representation
func (DeregisterTaskDefinitionOutput) SDKResponseMetadata ¶
func (s DeregisterTaskDefinitionOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DeregisterTaskDefinitionOutput) String ¶
func (s DeregisterTaskDefinitionOutput) String() string
String returns the string representation
type DeregisterTaskDefinitionRequest ¶
type DeregisterTaskDefinitionRequest struct { *aws.Request Input *DeregisterTaskDefinitionInput Copy func(*DeregisterTaskDefinitionInput) DeregisterTaskDefinitionRequest }
DeregisterTaskDefinitionRequest is a API request type for the DeregisterTaskDefinition API operation.
func (DeregisterTaskDefinitionRequest) Send ¶
func (r DeregisterTaskDefinitionRequest) Send() (*DeregisterTaskDefinitionOutput, error)
Send marshals and sends the DeregisterTaskDefinition API request.
type DescribeClustersInput ¶
type DescribeClustersInput struct { // A list of up to 100 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"` // Additional information about your clusters to be separated by launch type, // including: // // * runningEC2TasksCount // // * runningFargateTasksCount // // * pendingEC2TasksCount // // * pendingFargateTasksCount // // * activeEC2ServiceCount // // * activeFargateServiceCount // // * drainingEC2ServiceCount // // * drainingFargateServiceCount Include []ClusterField `locationName:"include" type:"list"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeClustersRequest
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeClustersResponse
func (DescribeClustersOutput) GoString ¶
func (s DescribeClustersOutput) GoString() string
GoString returns the string representation
func (DescribeClustersOutput) SDKResponseMetadata ¶
func (s DescribeClustersOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DescribeClustersOutput) String ¶
func (s DescribeClustersOutput) String() string
String returns the string representation
type DescribeClustersRequest ¶
type DescribeClustersRequest struct { *aws.Request Input *DescribeClustersInput Copy func(*DescribeClustersInput) DescribeClustersRequest }
DescribeClustersRequest is a API request type for the DescribeClusters API operation.
func (DescribeClustersRequest) Send ¶
func (r DescribeClustersRequest) Send() (*DescribeClustersOutput, error)
Send marshals and sends the DescribeClusters API request.
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 list of up to 100 container instance IDs or full Amazon Resource Name (ARN) // entries. // // ContainerInstances is a required field ContainerInstances []string `locationName:"containerInstances" type:"list" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeContainerInstancesRequest
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeContainerInstancesResponse
func (DescribeContainerInstancesOutput) GoString ¶
func (s DescribeContainerInstancesOutput) GoString() string
GoString returns the string representation
func (DescribeContainerInstancesOutput) SDKResponseMetadata ¶
func (s DescribeContainerInstancesOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DescribeContainerInstancesOutput) String ¶
func (s DescribeContainerInstancesOutput) String() string
String returns the string representation
type DescribeContainerInstancesRequest ¶
type DescribeContainerInstancesRequest struct { *aws.Request Input *DescribeContainerInstancesInput Copy func(*DescribeContainerInstancesInput) DescribeContainerInstancesRequest }
DescribeContainerInstancesRequest is a API request type for the DescribeContainerInstances API operation.
func (DescribeContainerInstancesRequest) Send ¶
func (r DescribeContainerInstancesRequest) Send() (*DescribeContainerInstancesOutput, error)
Send marshals and sends the DescribeContainerInstances API request.
type DescribeServicesInput ¶
type DescribeServicesInput struct { // The short name or full Amazon Resource Name (ARN)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. You may specify up to 10 services to describe // in a single operation. // // Services is a required field Services []string `locationName:"services" type:"list" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeServicesRequest
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeServicesResponse
func (DescribeServicesOutput) GoString ¶
func (s DescribeServicesOutput) GoString() string
GoString returns the string representation
func (DescribeServicesOutput) SDKResponseMetadata ¶
func (s DescribeServicesOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DescribeServicesOutput) String ¶
func (s DescribeServicesOutput) String() string
String returns the string representation
type DescribeServicesRequest ¶
type DescribeServicesRequest struct { *aws.Request Input *DescribeServicesInput Copy func(*DescribeServicesInput) DescribeServicesRequest }
DescribeServicesRequest is a API request type for the DescribeServices API operation.
func (DescribeServicesRequest) Send ¶
func (r DescribeServicesRequest) Send() (*DescribeServicesOutput, error)
Send marshals and sends the DescribeServices API request.
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 is a required field TaskDefinition *string `locationName:"taskDefinition" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTaskDefinitionRequest
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTaskDefinitionResponse
func (DescribeTaskDefinitionOutput) GoString ¶
func (s DescribeTaskDefinitionOutput) GoString() string
GoString returns the string representation
func (DescribeTaskDefinitionOutput) SDKResponseMetadata ¶
func (s DescribeTaskDefinitionOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DescribeTaskDefinitionOutput) String ¶
func (s DescribeTaskDefinitionOutput) String() string
String returns the string representation
type DescribeTaskDefinitionRequest ¶
type DescribeTaskDefinitionRequest struct { *aws.Request Input *DescribeTaskDefinitionInput Copy func(*DescribeTaskDefinitionInput) DescribeTaskDefinitionRequest }
DescribeTaskDefinitionRequest is a API request type for the DescribeTaskDefinition API operation.
func (DescribeTaskDefinitionRequest) Send ¶
func (r DescribeTaskDefinitionRequest) Send() (*DescribeTaskDefinitionOutput, error)
Send marshals and sends the DescribeTaskDefinition API request.
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 list of up to 100 task IDs or full ARN entries. // // Tasks is a required field Tasks []string `locationName:"tasks" type:"list" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTasksRequest
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTasksResponse
func (DescribeTasksOutput) GoString ¶
func (s DescribeTasksOutput) GoString() string
GoString returns the string representation
func (DescribeTasksOutput) SDKResponseMetadata ¶
func (s DescribeTasksOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DescribeTasksOutput) String ¶
func (s DescribeTasksOutput) String() string
String returns the string representation
type DescribeTasksRequest ¶
type DescribeTasksRequest struct { *aws.Request Input *DescribeTasksInput Copy func(*DescribeTasksInput) DescribeTasksRequest }
DescribeTasksRequest is a API request type for the DescribeTasks API operation.
func (DescribeTasksRequest) Send ¶
func (r DescribeTasksRequest) Send() (*DescribeTasksOutput, error)
Send marshals and sends the DescribeTasks API request.
type DesiredStatus ¶
type DesiredStatus string
const ( DesiredStatusRunning DesiredStatus = "RUNNING" DesiredStatusPending DesiredStatus = "PENDING" DesiredStatusStopped DesiredStatus = "STOPPED" )
Enum values for DesiredStatus
func (DesiredStatus) MarshalValue ¶
func (enum DesiredStatus) MarshalValue() (string, error)
func (DesiredStatus) MarshalValueBuf ¶
func (enum DesiredStatus) MarshalValueBuf(b []byte) ([]byte, error)
type Device ¶
type Device struct { // The path inside the container at which to expose the host device. ContainerPath *string `locationName:"containerPath" type:"string"` // The path for the device on the host container instance. // // HostPath is a required field HostPath *string `locationName:"hostPath" type:"string" required:"true"` // The explicit permissions to provide to the container for the device. By default, // the container has permissions for read, write, and mknod for the device. Permissions []DeviceCgroupPermission `locationName:"permissions" type:"list"` // contains filtered or unexported fields }
An object representing a container instance host device. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/Device
type DeviceCgroupPermission ¶
type DeviceCgroupPermission string
const ( DeviceCgroupPermissionRead DeviceCgroupPermission = "read" DeviceCgroupPermissionWrite DeviceCgroupPermission = "write" DeviceCgroupPermissionMknod DeviceCgroupPermission = "mknod" )
Enum values for DeviceCgroupPermission
func (DeviceCgroupPermission) MarshalValue ¶
func (enum DeviceCgroupPermission) MarshalValue() (string, error)
func (DeviceCgroupPermission) MarshalValueBuf ¶
func (enum DeviceCgroupPermission) MarshalValueBuf(b []byte) ([]byte, error)
type DiscoverPollEndpointInput ¶
type DiscoverPollEndpointInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster that the // container instance belongs to. Cluster *string `locationName:"cluster" type:"string"` // The container instance ID or full 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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DiscoverPollEndpointRequest
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DiscoverPollEndpointResponse
func (DiscoverPollEndpointOutput) GoString ¶
func (s DiscoverPollEndpointOutput) GoString() string
GoString returns the string representation
func (DiscoverPollEndpointOutput) SDKResponseMetadata ¶
func (s DiscoverPollEndpointOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (DiscoverPollEndpointOutput) String ¶
func (s DiscoverPollEndpointOutput) String() string
String returns the string representation
type DiscoverPollEndpointRequest ¶
type DiscoverPollEndpointRequest struct { *aws.Request Input *DiscoverPollEndpointInput Copy func(*DiscoverPollEndpointInput) DiscoverPollEndpointRequest }
DiscoverPollEndpointRequest is a API request type for the DiscoverPollEndpoint API operation.
func (DiscoverPollEndpointRequest) Send ¶
func (r DiscoverPollEndpointRequest) Send() (*DiscoverPollEndpointOutput, error)
Send marshals and sends the DiscoverPollEndpoint API request.
type ECS ¶
ECS provides the API operation methods for making requests to Amazon EC2 Container Service. See this package's package overview docs for details on the service.
ECS methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
New creates a new instance of the ECS client with a config.
Example:
// Create a ECS client from just a config. svc := ecs.New(myConfig)
func (*ECS) CreateClusterRequest ¶
func (c *ECS) CreateClusterRequest(input *CreateClusterInput) CreateClusterRequest
CreateClusterRequest returns a request value for making API operation for Amazon EC2 Container Service.
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.
When you call the CreateCluster API operation, Amazon ECS attempts to create the service-linked role for your account so that required resources in other AWS services can be managed on your behalf. However, if the IAM user that makes the call does not have permissions to create the service-linked role, it is not created. For more information, see Using Service-Linked Roles for Amazon ECS (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) in the Amazon Elastic Container Service Developer Guide.
// Example sending a request using the CreateClusterRequest method. req := client.CreateClusterRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateCluster
func (*ECS) CreateServiceRequest ¶
func (c *ECS) CreateServiceRequest(input *CreateServiceInput) CreateServiceRequest
CreateServiceRequest returns a request value for making API operation for Amazon EC2 Container Service.
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 copy of the task in the specified cluster. To update an existing service, see UpdateService.
In addition to maintaining the desired count of tasks in your service, you can optionally run your service behind a load balancer. The load balancer distributes traffic across the tasks that are associated with the service. For more information, see Service Load Balancing (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) in the Amazon Elastic Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. During a deployment, the service scheduler uses the minimumHealthyPercent and maximumPercent parameters to determine the deployment strategy. The deployment is triggered by changing the task definition or the desired count of a service with an UpdateService operation.
The minimumHealthyPercent represents a lower limit on the number of your service's tasks that must remain in the RUNNING state during a deployment, as a percentage of the desiredCount (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a desiredCount of four tasks and a minimumHealthyPercent of 50%, the scheduler can stop two existing tasks to free up cluster capacity 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 they are 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 your service's tasks that are allowed in the RUNNING or PENDING state during a deployment, as a percentage of the desiredCount (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service has a desiredCount of four tasks and a maximumPercent value of 200%, the scheduler can start 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 determines task placement in your cluster using 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).
By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy) with the placementStrategy parameter):
Sort the valid container instances, giving priority to instances that have
the fewest number of running tasks for this service in their respective Availability Zone. 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 sending a request using the CreateServiceRequest method. req := client.CreateServiceRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/CreateService
func (*ECS) DeleteAttributesRequest ¶
func (c *ECS) DeleteAttributesRequest(input *DeleteAttributesInput) DeleteAttributesRequest
DeleteAttributesRequest returns a request value for making API operation for Amazon EC2 Container Service.
Deletes one or more custom attributes from an Amazon ECS resource.
// Example sending a request using the DeleteAttributesRequest method. req := client.DeleteAttributesRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteAttributes
func (*ECS) DeleteClusterRequest ¶
func (c *ECS) DeleteClusterRequest(input *DeleteClusterInput) DeleteClusterRequest
DeleteClusterRequest returns a request value for making API operation for Amazon EC2 Container Service.
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 sending a request using the DeleteClusterRequest method. req := client.DeleteClusterRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteCluster
func (*ECS) DeleteServiceRequest ¶
func (c *ECS) DeleteServiceRequest(input *DeleteServiceInput) DeleteServiceRequest
DeleteServiceRequest returns a request value for making API operation for Amazon EC2 Container Service.
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 return a ServiceNotFoundException error.
// Example sending a request using the DeleteServiceRequest method. req := client.DeleteServiceRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeleteService
func (*ECS) DeregisterContainerInstanceRequest ¶
func (c *ECS) DeregisterContainerInstanceRequest(input *DeregisterContainerInstanceInput) DeregisterContainerInstanceRequest
DeregisterContainerInstanceRequest returns a request value for making API operation for Amazon EC2 Container Service.
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. That prevents 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.
If you terminate a running container instance, Amazon ECS automatically deregisters the instance from your cluster (stopped container instances or instances with disconnected agents are not automatically deregistered when terminated).
// Example sending a request using the DeregisterContainerInstanceRequest method. req := client.DeregisterContainerInstanceRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeregisterContainerInstance
func (*ECS) DeregisterTaskDefinitionRequest ¶
func (c *ECS) DeregisterTaskDefinitionRequest(input *DeregisterTaskDefinitionInput) DeregisterTaskDefinitionRequest
DeregisterTaskDefinitionRequest returns a request value for making API operation for Amazon EC2 Container Service.
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).
At this time, INACTIVE task definitions remain discoverable in your account indefinitely; however, this behavior is subject to change in the future, so you should not rely on INACTIVE task definitions persisting beyond the lifecycle of any associated tasks and services.
// Example sending a request using the DeregisterTaskDefinitionRequest method. req := client.DeregisterTaskDefinitionRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DeregisterTaskDefinition
func (*ECS) DescribeClustersRequest ¶
func (c *ECS) DescribeClustersRequest(input *DescribeClustersInput) DescribeClustersRequest
DescribeClustersRequest returns a request value for making API operation for Amazon EC2 Container Service.
Describes one or more of your clusters.
// Example sending a request using the DescribeClustersRequest method. req := client.DescribeClustersRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeClusters
func (*ECS) DescribeContainerInstancesRequest ¶
func (c *ECS) DescribeContainerInstancesRequest(input *DescribeContainerInstancesInput) DescribeContainerInstancesRequest
DescribeContainerInstancesRequest returns a request value for making API operation for Amazon EC2 Container Service.
Describes Amazon Elastic Container Service container instances. Returns metadata about registered and remaining resources on each container instance requested.
// Example sending a request using the DescribeContainerInstancesRequest method. req := client.DescribeContainerInstancesRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeContainerInstances
func (*ECS) DescribeServicesRequest ¶
func (c *ECS) DescribeServicesRequest(input *DescribeServicesInput) DescribeServicesRequest
DescribeServicesRequest returns a request value for making API operation for Amazon EC2 Container Service.
Describes the specified services running in your cluster.
// Example sending a request using the DescribeServicesRequest method. req := client.DescribeServicesRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeServices
func (*ECS) DescribeTaskDefinitionRequest ¶
func (c *ECS) DescribeTaskDefinitionRequest(input *DescribeTaskDefinitionInput) DescribeTaskDefinitionRequest
DescribeTaskDefinitionRequest returns a request value for making API operation for Amazon EC2 Container Service.
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 sending a request using the DescribeTaskDefinitionRequest method. req := client.DescribeTaskDefinitionRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTaskDefinition
func (*ECS) DescribeTasksRequest ¶
func (c *ECS) DescribeTasksRequest(input *DescribeTasksInput) DescribeTasksRequest
DescribeTasksRequest returns a request value for making API operation for Amazon EC2 Container Service.
Describes a specified task or tasks.
// Example sending a request using the DescribeTasksRequest method. req := client.DescribeTasksRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DescribeTasks
func (*ECS) DiscoverPollEndpointRequest ¶
func (c *ECS) DiscoverPollEndpointRequest(input *DiscoverPollEndpointInput) DiscoverPollEndpointRequest
DiscoverPollEndpointRequest returns a request value for making API operation for Amazon EC2 Container Service.
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Returns an endpoint for the Amazon ECS agent to poll for updates.
// Example sending a request using the DiscoverPollEndpointRequest method. req := client.DiscoverPollEndpointRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/DiscoverPollEndpoint
func (*ECS) ListAttributesRequest ¶
func (c *ECS) ListAttributesRequest(input *ListAttributesInput) ListAttributesRequest
ListAttributesRequest returns a request value for making API operation for Amazon EC2 Container Service.
Lists the attributes for Amazon ECS resources within a specified target type and cluster. When you specify a target type and cluster, ListAttributes returns a list of attribute objects, one for each attribute on each resource. You can filter the list of results to a single attribute name to only return results that have that name. You can also filter the results by attribute name and value, for example, to see which container instances in a cluster are running a Linux AMI (ecs.os-type=linux).
// Example sending a request using the ListAttributesRequest method. req := client.ListAttributesRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListAttributes
func (*ECS) ListClustersRequest ¶
func (c *ECS) ListClustersRequest(input *ListClustersInput) ListClustersRequest
ListClustersRequest returns a request value for making API operation for Amazon EC2 Container Service.
Returns a list of existing clusters.
// Example sending a request using the ListClustersRequest method. req := client.ListClustersRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListClusters
func (*ECS) ListContainerInstancesRequest ¶
func (c *ECS) ListContainerInstancesRequest(input *ListContainerInstancesInput) ListContainerInstancesRequest
ListContainerInstancesRequest returns a request value for making API operation for Amazon EC2 Container Service.
Returns a list of container instances in a specified cluster. You can filter the results of a ListContainerInstances operation with cluster query language statements inside the filter parameter. For more information, see Cluster Query Language (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the Amazon Elastic Container Service Developer Guide.
// Example sending a request using the ListContainerInstancesRequest method. req := client.ListContainerInstancesRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListContainerInstances
func (*ECS) ListServicesRequest ¶
func (c *ECS) ListServicesRequest(input *ListServicesInput) ListServicesRequest
ListServicesRequest returns a request value for making API operation for Amazon EC2 Container Service.
Lists the services that are running in a specified cluster.
// Example sending a request using the ListServicesRequest method. req := client.ListServicesRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListServices
func (*ECS) ListTaskDefinitionFamiliesRequest ¶
func (c *ECS) ListTaskDefinitionFamiliesRequest(input *ListTaskDefinitionFamiliesInput) ListTaskDefinitionFamiliesRequest
ListTaskDefinitionFamiliesRequest returns a request value for making API operation for Amazon EC2 Container Service.
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 definition revisions).
You can filter out task definition families that do not contain any ACTIVE task definition revisions by setting the status parameter to ACTIVE. You can also filter the results with the familyPrefix parameter.
// Example sending a request using the ListTaskDefinitionFamiliesRequest method. req := client.ListTaskDefinitionFamiliesRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListTaskDefinitionFamilies
func (*ECS) ListTaskDefinitionsRequest ¶
func (c *ECS) ListTaskDefinitionsRequest(input *ListTaskDefinitionsInput) ListTaskDefinitionsRequest
ListTaskDefinitionsRequest returns a request value for making API operation for Amazon EC2 Container Service.
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 sending a request using the ListTaskDefinitionsRequest method. req := client.ListTaskDefinitionsRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListTaskDefinitions
func (*ECS) ListTasksRequest ¶
func (c *ECS) ListTasksRequest(input *ListTasksInput) ListTasksRequest
ListTasksRequest returns a request value for making API operation for Amazon EC2 Container Service.
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.
Recently stopped tasks might appear in the returned results. Currently, stopped tasks appear in the returned results for at least one hour.
// Example sending a request using the ListTasksRequest method. req := client.ListTasksRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListTasks
func (*ECS) PutAttributesRequest ¶
func (c *ECS) PutAttributesRequest(input *PutAttributesInput) PutAttributesRequest
PutAttributesRequest returns a request value for making API operation for Amazon EC2 Container Service.
Create or update an attribute on an Amazon ECS resource. If the attribute does not exist, it is created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use DeleteAttributes. For more information, see Attributes (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes) in the Amazon Elastic Container Service Developer Guide.
// Example sending a request using the PutAttributesRequest method. req := client.PutAttributesRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PutAttributes
func (*ECS) RegisterContainerInstanceRequest ¶
func (c *ECS) RegisterContainerInstanceRequest(input *RegisterContainerInstanceInput) RegisterContainerInstanceRequest
RegisterContainerInstanceRequest returns a request value for making API operation for Amazon EC2 Container Service.
This action is only used by the Amazon ECS 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 sending a request using the RegisterContainerInstanceRequest method. req := client.RegisterContainerInstanceRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RegisterContainerInstance
func (*ECS) RegisterTaskDefinitionRequest ¶
func (c *ECS) RegisterTaskDefinitionRequest(input *RegisterTaskDefinitionInput) RegisterTaskDefinitionRequest
RegisterTaskDefinitionRequest returns a request value for making API operation for Amazon EC2 Container Service.
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 Elastic Container Service Developer Guide.
You can specify an IAM role for your task with the taskRoleArn parameter. When you specify an IAM role for a task, its containers can then use the latest versions of the AWS CLI or SDKs to make API requests to the AWS services that are specified in the IAM policy associated with the role. For more information, see IAM Roles for Tasks (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the Amazon Elastic Container Service Developer Guide.
You can specify a Docker networking mode for the containers in your task definition with the networkMode parameter. The available network modes correspond to those described in Network settings (https://docs.docker.com/engine/reference/run/#/network-settings) in the Docker run reference. If you specify the awsvpc network mode, the task is allocated an Elastic Network Interface, and you must specify a NetworkConfiguration when you create a service or run a task with the task definition. For more information, see Task Networking (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the Amazon Elastic Container Service Developer Guide.
// Example sending a request using the RegisterTaskDefinitionRequest method. req := client.RegisterTaskDefinitionRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RegisterTaskDefinition
func (*ECS) RunTaskRequest ¶
func (c *ECS) RunTaskRequest(input *RunTaskInput) RunTaskRequest
RunTaskRequest returns a request value for making API operation for Amazon EC2 Container Service.
Starts a new task using the specified task definition.
You can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places tasks using placement constraints and placement strategies. For more information, see Scheduling Tasks (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html) in the Amazon Elastic Container Service Developer Guide.
Alternatively, you can use StartTask to use your own scheduler or place tasks manually on specific container instances.
The Amazon ECS API follows an eventual consistency model, due to the distributed nature of the system supporting the API. This means that the result of an API command you run that affects your Amazon ECS resources might not be immediately visible to all subsequent commands you run. You should keep this in mind when you carry out an API command that immediately follows a previous API command.
To manage eventual consistency, you can do the following:
Confirm the state of the resource before you run a command to modify it. Run the DescribeTasks command using an exponential backoff algorithm to ensure that you allow enough time for the previous command to propagate through the system. To do this, run the DescribeTasks command repeatedly, starting with a couple of seconds of wait time, and increasing gradually up to five minutes of wait time.
Add wait time between subsequent commands, even if the DescribeTasks command returns an accurate response. Apply an exponential backoff algorithm starting with a couple of seconds of wait time, and increase gradually up to about five minutes of wait time.
// Example sending a request using the RunTaskRequest method. req := client.RunTaskRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RunTask
func (*ECS) StartTaskRequest ¶
func (c *ECS) StartTaskRequest(input *StartTaskInput) StartTaskRequest
StartTaskRequest returns a request value for making API operation for Amazon EC2 Container Service.
Starts a new task from the specified task definition on the specified container instance or instances.
Alternatively, you can use RunTask to place tasks for you. For more information, see Scheduling Tasks (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/scheduling_tasks.html) in the Amazon Elastic Container Service Developer Guide.
// Example sending a request using the StartTaskRequest method. req := client.StartTaskRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/StartTask
func (*ECS) StopTaskRequest ¶
func (c *ECS) StopTaskRequest(input *StopTaskInput) StopTaskRequest
StopTaskRequest returns a request value for making API operation for Amazon EC2 Container Service.
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 default 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.
The default 30-second timeout can be configured on the Amazon ECS container agent with the ECS_CONTAINER_STOP_TIMEOUT variable. For more information, see Amazon ECS Container Agent Configuration (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the Amazon Elastic Container Service Developer Guide.
// Example sending a request using the StopTaskRequest method. req := client.StopTaskRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/StopTask
func (*ECS) SubmitContainerStateChangeRequest ¶
func (c *ECS) SubmitContainerStateChangeRequest(input *SubmitContainerStateChangeInput) SubmitContainerStateChangeRequest
SubmitContainerStateChangeRequest returns a request value for making API operation for Amazon EC2 Container Service.
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a container changed states.
// Example sending a request using the SubmitContainerStateChangeRequest method. req := client.SubmitContainerStateChangeRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/SubmitContainerStateChange
func (*ECS) SubmitTaskStateChangeRequest ¶
func (c *ECS) SubmitTaskStateChangeRequest(input *SubmitTaskStateChangeInput) SubmitTaskStateChangeRequest
SubmitTaskStateChangeRequest returns a request value for making API operation for Amazon EC2 Container Service.
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
Sent to acknowledge that a task changed states.
// Example sending a request using the SubmitTaskStateChangeRequest method. req := client.SubmitTaskStateChangeRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/SubmitTaskStateChange
func (*ECS) UpdateContainerAgentRequest ¶
func (c *ECS) UpdateContainerAgentRequest(input *UpdateContainerAgentInput) UpdateContainerAgentRequest
UpdateContainerAgentRequest returns a request value for making API operation for Amazon EC2 Container Service.
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 Elastic Container Service Developer Guide.
// Example sending a request using the UpdateContainerAgentRequest method. req := client.UpdateContainerAgentRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateContainerAgent
func (*ECS) UpdateContainerInstancesStateRequest ¶
func (c *ECS) UpdateContainerInstancesStateRequest(input *UpdateContainerInstancesStateInput) UpdateContainerInstancesStateRequest
UpdateContainerInstancesStateRequest returns a request value for making API operation for Amazon EC2 Container Service.
Modifies the status of an Amazon ECS container instance.
You can change the status of a container instance to DRAINING to manually remove an instance from a cluster, for example to perform system updates, update the Docker daemon, or scale down the cluster size.
When you set a container instance to DRAINING, Amazon ECS prevents new tasks from being scheduled for placement on the container instance and replacement service tasks are started on other container instances in the cluster if the resources are available. Service tasks on the container instance that are in the PENDING state are stopped immediately.
Service tasks on the container instance that are in the RUNNING state are stopped and replaced according to the service's deployment configuration parameters, minimumHealthyPercent and maximumPercent. You can change the deployment configuration of your service using UpdateService.
If minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during task replacement. For example, desiredCount is four tasks, a minimum of 50% allows the scheduler to stop two existing tasks before starting two new tasks. If the minimum is 100%, the service scheduler can't remove existing tasks until the replacement tasks are considered healthy. Tasks for services that do not use a load balancer are considered healthy if they are in the RUNNING state. Tasks for services that use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are hosted on is reported as healthy by the load balancer.
The maximumPercent parameter represents an upper limit on the number of running tasks during task replacement, which enables you to define the replacement batch size. For example, if desiredCount of four tasks, a maximum of 200% starts four new tasks before stopping the four tasks to be drained (provided that the cluster resources required to do this are available). If the maximum is 100%, then replacement tasks can't start until the draining tasks have stopped.
Any PENDING or RUNNING tasks that do not belong to a service are not affected; you must wait for them to finish or stop them manually.
A container instance has completed draining when it has no more RUNNING tasks. You can verify this using ListTasks.
When you set a container instance to ACTIVE, the Amazon ECS scheduler can begin scheduling tasks on the instance again.
// Example sending a request using the UpdateContainerInstancesStateRequest method. req := client.UpdateContainerInstancesStateRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateContainerInstancesState
func (*ECS) UpdateServiceRequest ¶
func (c *ECS) UpdateServiceRequest(input *UpdateServiceInput) UpdateServiceRequest
UpdateServiceRequest returns a request value for making API operation for Amazon EC2 Container Service.
Modifies the desired count, deployment configuration, network 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.
If you have updated the Docker image of your application, you can create a new task definition with that image and deploy it to your service. The service scheduler uses the minimum healthy percent and maximum percent parameters (in the service's deployment configuration) to determine the deployment strategy.
If your updated Docker image uses the same tag as what is in the existing task definition for your service (for example, my_image:latest), you do not need to create a new revision of your task definition. You can update the service using the forceNewDeployment option. The new tasks launched by the deployment pull the current image/tag combination from your repository when they start.
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 minimumHealthyPercent is below 100%, the scheduler can ignore desiredCount temporarily during a deployment. For example, if desiredCount is four tasks, a minimum 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 use a load balancer are considered healthy if they are in the RUNNING state and the container instance they are 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 desiredCount is four tasks, a maximum 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 determines task placement 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).
By default, the service scheduler attempts to balance tasks across Availability Zones in this manner (although you can choose a different placement strategy):
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.
When the service scheduler stops running tasks, it attempts to maintain balance across the Availability Zones in your cluster using the following logic:
Sort the container instances by the largest 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 two, container instances in either zone B or C are considered optimal for termination.
Stop the task on a container instance in an optimal Availability Zone (based on the previous steps), favoring container instances with the largest number of running tasks for this service.
// Example sending a request using the UpdateServiceRequest method. req := client.UpdateServiceRequest(params) resp, err := req.Send() if err == nil { fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateService
func (*ECS) WaitUntilServicesInactive ¶
func (c *ECS) WaitUntilServicesInactive(input *DescribeServicesInput) error
WaitUntilServicesInactive uses the Amazon ECS API operation DescribeServices to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.
func (*ECS) WaitUntilServicesInactiveWithContext ¶
func (c *ECS) WaitUntilServicesInactiveWithContext(ctx aws.Context, input *DescribeServicesInput, opts ...aws.WaiterOption) error
WaitUntilServicesInactiveWithContext is an extended version of WaitUntilServicesInactive. With the support for passing in a context and options to configure the Waiter and the underlying request options.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*ECS) WaitUntilServicesStable ¶
func (c *ECS) WaitUntilServicesStable(input *DescribeServicesInput) error
WaitUntilServicesStable uses the Amazon ECS API operation DescribeServices to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.
func (*ECS) WaitUntilServicesStableWithContext ¶
func (c *ECS) WaitUntilServicesStableWithContext(ctx aws.Context, input *DescribeServicesInput, opts ...aws.WaiterOption) error
WaitUntilServicesStableWithContext is an extended version of WaitUntilServicesStable. With the support for passing in a context and options to configure the Waiter and the underlying request options.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*ECS) WaitUntilTasksRunning ¶
func (c *ECS) WaitUntilTasksRunning(input *DescribeTasksInput) error
WaitUntilTasksRunning uses the Amazon ECS API operation DescribeTasks to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.
func (*ECS) WaitUntilTasksRunningWithContext ¶
func (c *ECS) WaitUntilTasksRunningWithContext(ctx aws.Context, input *DescribeTasksInput, opts ...aws.WaiterOption) error
WaitUntilTasksRunningWithContext is an extended version of WaitUntilTasksRunning. With the support for passing in a context and options to configure the Waiter and the underlying request options.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*ECS) WaitUntilTasksStopped ¶
func (c *ECS) WaitUntilTasksStopped(input *DescribeTasksInput) error
WaitUntilTasksStopped uses the Amazon ECS API operation DescribeTasks to wait for a condition to be met before returning. If the condition is not met within the max attempt window, an error will be returned.
func (*ECS) WaitUntilTasksStoppedWithContext ¶
func (c *ECS) WaitUntilTasksStoppedWithContext(ctx aws.Context, input *DescribeTasksInput, opts ...aws.WaiterOption) error
WaitUntilTasksStoppedWithContext is an extended version of WaitUntilTasksStopped. With the support for passing in a context and options to configure the Waiter and the underlying request options.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
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. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/Failure
type HealthCheck ¶
type HealthCheck struct { // A string array representing the command that the container runs to determine // if it is healthy. The string array must start with CMD to execute the command // arguments directly, or CMD-SHELL to run the command with the container's // default shell. For example: // // [ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ] // // An exit code of 0 indicates success, and non-zero exit code indicates failure. // For more information, see HealthCheck in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/). // // Command is a required field Command []string `locationName:"command" type:"list" required:"true"` // The time period in seconds between each health check execution. You may specify // between 5 and 300 seconds. The default value is 30 seconds. Interval *int64 `locationName:"interval" type:"integer"` // The number of times to retry a failed health check before the container is // considered unhealthy. You may specify between 1 and 10 retries. The default // value is 3 retries. Retries *int64 `locationName:"retries" type:"integer"` // The optional grace period within which to provide containers time to bootstrap // before failed health checks count towards the maximum number of retries. // You may specify between 0 and 300 seconds. The startPeriod is disabled by // default. // // If a health check succeeds within the startPeriod, then the container is // considered healthy and any subsequent failures count toward the maximum number // of retries. StartPeriod *int64 `locationName:"startPeriod" type:"integer"` // The time period in seconds to wait for a health check to succeed before it // is considered a failure. You may specify between 2 and 60 seconds. The default // value is 5 seconds. Timeout *int64 `locationName:"timeout" type:"integer"` // contains filtered or unexported fields }
An object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile). Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/HealthCheck
func (HealthCheck) GoString ¶
func (s HealthCheck) GoString() string
GoString returns the string representation
func (HealthCheck) String ¶
func (s HealthCheck) String() string
String returns the string representation
func (*HealthCheck) Validate ¶
func (s *HealthCheck) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type HealthStatus ¶
type HealthStatus string
const ( HealthStatusHealthy HealthStatus = "HEALTHY" HealthStatusUnhealthy HealthStatus = "UNHEALTHY" HealthStatusUnknown HealthStatus = "UNKNOWN" )
Enum values for HealthStatus
func (HealthStatus) MarshalValue ¶
func (enum HealthStatus) MarshalValue() (string, error)
func (HealthStatus) MarshalValueBuf ¶
func (enum HealthStatus) MarshalValueBuf(b []byte) ([]byte, error)
type HostEntry ¶
type HostEntry struct { // The hostname to use in the /etc/hosts entry. // // Hostname is a required field Hostname *string `locationName:"hostname" type:"string" required:"true"` // The IP address to use in the /etc/hosts entry. // // IpAddress is a required field 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/HostEntry
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. // // If you are using the Fargate launch type, the sourcePath parameter is not // supported. SourcePath *string `locationName:"sourcePath" type:"string"` // contains filtered or unexported fields }
Details on a container instance host volume. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/HostVolumeProperties
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 KernelCapabilities ¶
type KernelCapabilities struct { // The Linux capabilities for the container that have been added to the default // configuration provided by Docker. This parameter maps to CapAdd in the Create // a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --cap-add option to docker run (https://docs.docker.com/engine/reference/run/). // // If you are using tasks that use the Fargate launch type, the add parameter // is not supported. // // Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | // "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" // | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" // | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" // | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" // | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | // "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | // "WAKE_ALARM" Add []string `locationName:"add" type:"list"` // The Linux capabilities for the container that have been removed from the // default configuration provided by Docker. This parameter maps to CapDrop // in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --cap-drop option to docker run (https://docs.docker.com/engine/reference/run/). // // Valid values: "ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | // "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" // | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" // | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" // | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" // | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | // "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | // "WAKE_ALARM" Drop []string `locationName:"drop" type:"list"` // contains filtered or unexported fields }
The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For more information on the default capabilities and the non-default available capabilities, see Runtime privilege and Linux capabilities (https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities) in the Docker run reference. For more detailed information on these Linux capabilities, see the capabilities(7) (http://man7.org/linux/man-pages/man7/capabilities.7.html) Linux manual page. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/KernelCapabilities
func (KernelCapabilities) GoString ¶
func (s KernelCapabilities) GoString() string
GoString returns the string representation
func (KernelCapabilities) String ¶
func (s KernelCapabilities) 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/KeyValuePair
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 LaunchType ¶
type LaunchType string
const ( LaunchTypeEc2 LaunchType = "EC2" LaunchTypeFargate LaunchType = "FARGATE" )
Enum values for LaunchType
func (LaunchType) MarshalValue ¶
func (enum LaunchType) MarshalValue() (string, error)
func (LaunchType) MarshalValueBuf ¶
func (enum LaunchType) MarshalValueBuf(b []byte) ([]byte, error)
type LinuxParameters ¶
type LinuxParameters struct { // The Linux capabilities for the container that are added to or dropped from // the default configuration provided by Docker. // // If you are using tasks that use the Fargate launch type, capabilities is // supported but the add parameter is not supported. Capabilities *KernelCapabilities `locationName:"capabilities" type:"structure"` // Any host devices to expose to the container. This parameter maps to Devices // in the Create a container (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/#create-a-container) // section of the Docker Remote API (https://docs.docker.com/engine/reference/api/docker_remote_api_v1.27/) // and the --device option to docker run (https://docs.docker.com/engine/reference/run/). // // If you are using tasks that use the Fargate launch type, the devices parameter // is not supported. Devices []Device `locationName:"devices" type:"list"` // Run an init process inside the container that forwards signals and reaps // processes. This parameter maps to the --init option to docker run (https://docs.docker.com/engine/reference/run/). // This parameter requires version 1.25 of the Docker Remote API or greater // on your container instance. To check the Docker Remote API version on your // container instance, log in to your container instance and run the following // command: sudo docker version | grep "Server API version" InitProcessEnabled *bool `locationName:"initProcessEnabled" type:"boolean"` // to the --shm-size option to docker run (https://docs.docker.com/engine/reference/run/). // // If you are using tasks that use the Fargate launch type, the sharedMemorySize // parameter is not supported. SharedMemorySize *int64 `locationName:"sharedMemorySize" type:"integer"` // The container path, mount options, and size (in MiB) of the tmpfs mount. // This parameter maps to the --tmpfs option to docker run (https://docs.docker.com/engine/reference/run/). // // If you are using tasks that use the Fargate launch type, the tmpfs parameter // is not supported. Tmpfs []Tmpfs `locationName:"tmpfs" type:"list"` // contains filtered or unexported fields }
Linux-specific options that are applied to the container, such as Linux KernelCapabilities. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/LinuxParameters
func (LinuxParameters) GoString ¶
func (s LinuxParameters) GoString() string
GoString returns the string representation
func (LinuxParameters) String ¶
func (s LinuxParameters) String() string
String returns the string representation
func (*LinuxParameters) Validate ¶
func (s *LinuxParameters) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListAttributesInput ¶
type ListAttributesInput struct { // The name of the attribute with which to filter the results. AttributeName *string `locationName:"attributeName" type:"string"` // The value of the attribute with which to filter results. You must also specify // an attribute name to use this parameter. AttributeValue *string `locationName:"attributeValue" type:"string"` // The short name or full Amazon Resource Name (ARN) of the cluster to list // attributes. If you do not specify a cluster, the default cluster is assumed. Cluster *string `locationName:"cluster" type:"string"` // The maximum number of cluster results returned by ListAttributes in paginated // output. When this parameter is used, ListAttributes 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 ListAttributes // request with the returned nextToken value. This value can be between 1 and // 100. If this parameter is not used, then ListAttributes 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 ListAttributes 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 token should be treated as an opaque identifier that is only used to // retrieve the next items in a list and not for other programmatic purposes. NextToken *string `locationName:"nextToken" type:"string"` // The type of the target with which to list attributes. // // TargetType is a required field TargetType TargetType `locationName:"targetType" type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListAttributesRequest
func (ListAttributesInput) GoString ¶
func (s ListAttributesInput) GoString() string
GoString returns the string representation
func (ListAttributesInput) String ¶
func (s ListAttributesInput) String() string
String returns the string representation
func (*ListAttributesInput) Validate ¶
func (s *ListAttributesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListAttributesOutput ¶
type ListAttributesOutput struct { // A list of attribute objects that meet the criteria of the request. Attributes []Attribute `locationName:"attributes" type:"list"` // The nextToken value to include in a future ListAttributes request. When the // results of a ListAttributes 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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListAttributesResponse
func (ListAttributesOutput) GoString ¶
func (s ListAttributesOutput) GoString() string
GoString returns the string representation
func (ListAttributesOutput) SDKResponseMetadata ¶
func (s ListAttributesOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListAttributesOutput) String ¶
func (s ListAttributesOutput) String() string
String returns the string representation
type ListAttributesRequest ¶
type ListAttributesRequest struct { *aws.Request Input *ListAttributesInput Copy func(*ListAttributesInput) ListAttributesRequest }
ListAttributesRequest is a API request type for the ListAttributes API operation.
func (ListAttributesRequest) Send ¶
func (r ListAttributesRequest) Send() (*ListAttributesOutput, error)
Send marshals and sends the ListAttributes API request.
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 token should be treated as an opaque identifier that is only used to // retrieve the next items in a list and not for other programmatic purposes. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListClustersRequest
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListClustersResponse
func (ListClustersOutput) GoString ¶
func (s ListClustersOutput) GoString() string
GoString returns the string representation
func (ListClustersOutput) SDKResponseMetadata ¶
func (s ListClustersOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListClustersOutput) String ¶
func (s ListClustersOutput) String() string
String returns the string representation
type ListClustersPager ¶
ListClustersPager is used to paginate the request. This can be done by calling Next and CurrentPage.
func (*ListClustersPager) CurrentPage ¶
func (p *ListClustersPager) CurrentPage() *ListClustersOutput
type ListClustersRequest ¶
type ListClustersRequest struct { *aws.Request Input *ListClustersInput Copy func(*ListClustersInput) ListClustersRequest }
ListClustersRequest is a API request type for the ListClusters API operation.
func (*ListClustersRequest) Paginate ¶
func (p *ListClustersRequest) Paginate(opts ...aws.Option) ListClustersPager
Paginate pages iterates over the pages of a ListClustersRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListClusters operation. req := client.ListClustersRequest(input) p := req.Paginate() for p.Next() { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (ListClustersRequest) Send ¶
func (r ListClustersRequest) Send() (*ListClustersOutput, error)
Send marshals and sends the ListClusters API request.
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"` // You can filter the results of a ListContainerInstances operation with cluster // query language statements. For more information, see Cluster Query Language // (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) // in the Amazon Elastic Container Service Developer Guide. Filter *string `locationName:"filter" 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 token should be treated as an opaque identifier that is only used to // retrieve the next items in a list and not for other programmatic purposes. NextToken *string `locationName:"nextToken" type:"string"` // Filters the container instances by status. For example, if you specify the // DRAINING status, the results include only container instances that have been // set to DRAINING using UpdateContainerInstancesState. If you do not specify // this parameter, the default is to include container instances set to ACTIVE // and DRAINING. Status ContainerInstanceStatus `locationName:"status" type:"string" enum:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListContainerInstancesRequest
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 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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListContainerInstancesResponse
func (ListContainerInstancesOutput) GoString ¶
func (s ListContainerInstancesOutput) GoString() string
GoString returns the string representation
func (ListContainerInstancesOutput) SDKResponseMetadata ¶
func (s ListContainerInstancesOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListContainerInstancesOutput) String ¶
func (s ListContainerInstancesOutput) String() string
String returns the string representation
type ListContainerInstancesPager ¶
ListContainerInstancesPager is used to paginate the request. This can be done by calling Next and CurrentPage.
func (*ListContainerInstancesPager) CurrentPage ¶
func (p *ListContainerInstancesPager) CurrentPage() *ListContainerInstancesOutput
type ListContainerInstancesRequest ¶
type ListContainerInstancesRequest struct { *aws.Request Input *ListContainerInstancesInput Copy func(*ListContainerInstancesInput) ListContainerInstancesRequest }
ListContainerInstancesRequest is a API request type for the ListContainerInstances API operation.
func (*ListContainerInstancesRequest) Paginate ¶
func (p *ListContainerInstancesRequest) Paginate(opts ...aws.Option) ListContainerInstancesPager
Paginate pages iterates over the pages of a ListContainerInstancesRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListContainerInstances operation. req := client.ListContainerInstancesRequest(input) p := req.Paginate() for p.Next() { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (ListContainerInstancesRequest) Send ¶
func (r ListContainerInstancesRequest) Send() (*ListContainerInstancesOutput, error)
Send marshals and sends the ListContainerInstances API request.
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 launch type for services you want to list. LaunchType LaunchType `locationName:"launchType" type:"string" enum:"true"` // The maximum number of service 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 token should be treated as an opaque identifier that is only used to // retrieve the next items in a list and not for other programmatic purposes. NextToken *string `locationName:"nextToken" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListServicesRequest
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 ARN entries for each service associated with the specified // cluster. ServiceArns []string `locationName:"serviceArns" type:"list"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListServicesResponse
func (ListServicesOutput) GoString ¶
func (s ListServicesOutput) GoString() string
GoString returns the string representation
func (ListServicesOutput) SDKResponseMetadata ¶
func (s ListServicesOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListServicesOutput) String ¶
func (s ListServicesOutput) String() string
String returns the string representation
type ListServicesPager ¶
ListServicesPager is used to paginate the request. This can be done by calling Next and CurrentPage.
func (*ListServicesPager) CurrentPage ¶
func (p *ListServicesPager) CurrentPage() *ListServicesOutput
type ListServicesRequest ¶
type ListServicesRequest struct { *aws.Request Input *ListServicesInput Copy func(*ListServicesInput) ListServicesRequest }
ListServicesRequest is a API request type for the ListServices API operation.
func (*ListServicesRequest) Paginate ¶
func (p *ListServicesRequest) Paginate(opts ...aws.Option) ListServicesPager
Paginate pages iterates over the pages of a ListServicesRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListServices operation. req := client.ListServicesRequest(input) p := req.Paginate() for p.Next() { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (ListServicesRequest) Send ¶
func (r ListServicesRequest) Send() (*ListServicesOutput, error)
Send marshals and sends the ListServices API request.
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 token should be treated as an opaque identifier that is only used to // retrieve the next items in a list and not for other programmatic purposes. NextToken *string `locationName:"nextToken" type:"string"` // The task definition family status with which to filter the ListTaskDefinitionFamilies // results. By default, both ACTIVE and INACTIVE task definition families are // listed. If this parameter is set to ACTIVE, only task definition families // that have an ACTIVE task definition revision are returned. If this parameter // is set to INACTIVE, only task definition families that do not have any ACTIVE // task definition revisions are returned. If you paginate the resulting output, // be sure to keep the status value constant in each subsequent request. Status TaskDefinitionFamilyStatus `locationName:"status" type:"string" enum:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListTaskDefinitionFamiliesRequest
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListTaskDefinitionFamiliesResponse
func (ListTaskDefinitionFamiliesOutput) GoString ¶
func (s ListTaskDefinitionFamiliesOutput) GoString() string
GoString returns the string representation
func (ListTaskDefinitionFamiliesOutput) SDKResponseMetadata ¶
func (s ListTaskDefinitionFamiliesOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListTaskDefinitionFamiliesOutput) String ¶
func (s ListTaskDefinitionFamiliesOutput) String() string
String returns the string representation
type ListTaskDefinitionFamiliesPager ¶
ListTaskDefinitionFamiliesPager is used to paginate the request. This can be done by calling Next and CurrentPage.
func (*ListTaskDefinitionFamiliesPager) CurrentPage ¶
func (p *ListTaskDefinitionFamiliesPager) CurrentPage() *ListTaskDefinitionFamiliesOutput
type ListTaskDefinitionFamiliesRequest ¶
type ListTaskDefinitionFamiliesRequest struct { *aws.Request Input *ListTaskDefinitionFamiliesInput Copy func(*ListTaskDefinitionFamiliesInput) ListTaskDefinitionFamiliesRequest }
ListTaskDefinitionFamiliesRequest is a API request type for the ListTaskDefinitionFamilies API operation.
func (*ListTaskDefinitionFamiliesRequest) Paginate ¶
func (p *ListTaskDefinitionFamiliesRequest) Paginate(opts ...aws.Option) ListTaskDefinitionFamiliesPager
Paginate pages iterates over the pages of a ListTaskDefinitionFamiliesRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListTaskDefinitionFamilies operation. req := client.ListTaskDefinitionFamiliesRequest(input) p := req.Paginate() for p.Next() { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (ListTaskDefinitionFamiliesRequest) Send ¶
func (r ListTaskDefinitionFamiliesRequest) Send() (*ListTaskDefinitionFamiliesOutput, error)
Send marshals and sends the ListTaskDefinitionFamilies API request.
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 token should be treated as an opaque identifier that is only used to // retrieve the next items in a list and not for other programmatic purposes. 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 SortOrder `locationName:"sort" type:"string" enum:"true"` // 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 TaskDefinitionStatus `locationName:"status" type:"string" enum:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListTaskDefinitionsRequest
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListTaskDefinitionsResponse
func (ListTaskDefinitionsOutput) GoString ¶
func (s ListTaskDefinitionsOutput) GoString() string
GoString returns the string representation
func (ListTaskDefinitionsOutput) SDKResponseMetadata ¶
func (s ListTaskDefinitionsOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListTaskDefinitionsOutput) String ¶
func (s ListTaskDefinitionsOutput) String() string
String returns the string representation
type ListTaskDefinitionsPager ¶
ListTaskDefinitionsPager is used to paginate the request. This can be done by calling Next and CurrentPage.
func (*ListTaskDefinitionsPager) CurrentPage ¶
func (p *ListTaskDefinitionsPager) CurrentPage() *ListTaskDefinitionsOutput
type ListTaskDefinitionsRequest ¶
type ListTaskDefinitionsRequest struct { *aws.Request Input *ListTaskDefinitionsInput Copy func(*ListTaskDefinitionsInput) ListTaskDefinitionsRequest }
ListTaskDefinitionsRequest is a API request type for the ListTaskDefinitions API operation.
func (*ListTaskDefinitionsRequest) Paginate ¶
func (p *ListTaskDefinitionsRequest) Paginate(opts ...aws.Option) ListTaskDefinitionsPager
Paginate pages iterates over the pages of a ListTaskDefinitionsRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListTaskDefinitions operation. req := client.ListTaskDefinitionsRequest(input) p := req.Paginate() for p.Next() { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (ListTaskDefinitionsRequest) Send ¶
func (r ListTaskDefinitionsRequest) Send() (*ListTaskDefinitionsOutput, error)
Send marshals and sends the ListTaskDefinitions API request.
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 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 desired status with which to filter the ListTasks results. Specifying // a desiredStatus of STOPPED limits the results to tasks that Amazon ECS has // set the desired status to STOPPED, which can be useful for debugging tasks // that are not starting properly or have died or finished. The default status // filter is RUNNING, which shows tasks that Amazon ECS has set the desired // status to RUNNING. // // Although you can filter results based on a desired status of PENDING, this // does not return any results because Amazon ECS never sets the desired status // of a task to that value (only a task's lastStatus may have a value of PENDING). DesiredStatus DesiredStatus `locationName:"desiredStatus" type:"string" enum:"true"` // 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 launch type for services you want to list. LaunchType LaunchType `locationName:"launchType" type:"string" enum:"true"` // 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 token should be treated as an opaque identifier that is only used to // retrieve the next items in a list and not for other programmatic purposes. 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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListTasksRequest
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 ARN entries for the ListTasks request. TaskArns []string `locationName:"taskArns" type:"list"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListTasksResponse
func (ListTasksOutput) GoString ¶
func (s ListTasksOutput) GoString() string
GoString returns the string representation
func (ListTasksOutput) SDKResponseMetadata ¶
func (s ListTasksOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (ListTasksOutput) String ¶
func (s ListTasksOutput) String() string
String returns the string representation
type ListTasksPager ¶
ListTasksPager is used to paginate the request. This can be done by calling Next and CurrentPage.
func (*ListTasksPager) CurrentPage ¶
func (p *ListTasksPager) CurrentPage() *ListTasksOutput
type ListTasksRequest ¶
type ListTasksRequest struct { *aws.Request Input *ListTasksInput Copy func(*ListTasksInput) ListTasksRequest }
ListTasksRequest is a API request type for the ListTasks API operation.
func (*ListTasksRequest) Paginate ¶
func (p *ListTasksRequest) Paginate(opts ...aws.Option) ListTasksPager
Paginate pages iterates over the pages of a ListTasksRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListTasks operation. req := client.ListTasksRequest(input) p := req.Paginate() for p.Next() { page := p.CurrentPage() } if err := p.Err(); err != nil { return err }
func (ListTasksRequest) Send ¶
func (r ListTasksRequest) Send() (*ListTasksOutput, error)
Send marshals and sends the ListTasks API request.
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 a load balancer. LoadBalancerName *string `locationName:"loadBalancerName" type:"string"` // The full Amazon Resource Name (ARN) of the Elastic Load Balancing target // group associated with a service. // // If your service's task definition uses the awsvpc network mode (which is // required for the Fargate launch type), you must choose ip as the target type, // not instance, because tasks that use the awsvpc network mode are associated // with an elastic network interface, not an Amazon EC2 instance. TargetGroupArn *string `locationName:"targetGroupArn" type:"string"` // contains filtered or unexported fields }
Details on a load balancer that is used with a service.
Services with tasks that use the awsvpc network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers; Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose ip as the target type, not instance, because tasks that use the awsvpc network mode are associated with an elastic network interface, not an Amazon EC2 instance. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/LoadBalancer
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. The valid values listed for this // parameter are log drivers that the Amazon ECS container agent can communicate // with by default. If using the Fargate launch type, the only supported value // is awslogs. For more information about using the awslogs driver, see Using // the awslogs Log Driver (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) // in the Amazon Elastic Container Service Developer Guide. // // If you have a custom driver that is not listed above that you would like // to work with the Amazon ECS container agent, you can fork the Amazon ECS // container agent project that is available on GitHub (https://github.com/aws/amazon-ecs-agent) // and customize it to work with that driver. We encourage you to submit pull // requests for changes that you would like to have included. However, Amazon // Web Services does not currently support running modified copies of this software. // // 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 in to your container instance and run the following // command: sudo docker version | grep "Server API version" // // LogDriver is a required field LogDriver LogDriver `locationName:"logDriver" type:"string" required:"true" enum:"true"` // 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 in // to 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/LogConfiguration
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 LogDriver ¶
type LogDriver string
const ( LogDriverJsonFile LogDriver = "json-file" LogDriverSyslog LogDriver = "syslog" LogDriverJournald LogDriver = "journald" LogDriverGelf LogDriver = "gelf" LogDriverFluentd LogDriver = "fluentd" LogDriverAwslogs LogDriver = "awslogs" LogDriverSplunk LogDriver = "splunk" )
Enum values for LogDriver
func (LogDriver) MarshalValue ¶
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. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/MountPoint
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 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 TransportProtocol `locationName:"protocol" type:"string" enum:"true"` // 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/NetworkBinding
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 NetworkConfiguration ¶
type NetworkConfiguration struct { // The VPC subnets and security groups associated with a task. AwsvpcConfiguration *AwsVpcConfiguration `locationName:"awsvpcConfiguration" type:"structure"` // contains filtered or unexported fields }
An object representing the network configuration for a task or service. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/NetworkConfiguration
func (NetworkConfiguration) GoString ¶
func (s NetworkConfiguration) GoString() string
GoString returns the string representation
func (NetworkConfiguration) String ¶
func (s NetworkConfiguration) String() string
String returns the string representation
func (*NetworkConfiguration) Validate ¶
func (s *NetworkConfiguration) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type NetworkInterface ¶
type NetworkInterface struct { // The attachment ID for the network interface. AttachmentId *string `locationName:"attachmentId" type:"string"` // The private IPv6 address for the network interface. Ipv6Address *string `locationName:"ipv6Address" type:"string"` // The private IPv4 address for the network interface. PrivateIpv4Address *string `locationName:"privateIpv4Address" type:"string"` // contains filtered or unexported fields }
An object representing the Elastic Network Interface for tasks that use the awsvpc network mode. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/NetworkInterface
func (NetworkInterface) GoString ¶
func (s NetworkInterface) GoString() string
GoString returns the string representation
func (NetworkInterface) String ¶
func (s NetworkInterface) String() string
String returns the string representation
type NetworkMode ¶
type NetworkMode string
const ( NetworkModeBridge NetworkMode = "bridge" NetworkModeHost NetworkMode = "host" NetworkModeAwsvpc NetworkMode = "awsvpc" NetworkModeNone NetworkMode = "none" )
Enum values for NetworkMode
func (NetworkMode) MarshalValue ¶
func (enum NetworkMode) MarshalValue() (string, error)
func (NetworkMode) MarshalValueBuf ¶
func (enum NetworkMode) MarshalValueBuf(b []byte) ([]byte, error)
type PlacementConstraint ¶
type PlacementConstraint struct { // A cluster query language expression to apply to the constraint. Note you // cannot specify an expression if the constraint type is distinctInstance. // For more information, see Cluster Query Language (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) // in the Amazon Elastic Container Service Developer Guide. Expression *string `locationName:"expression" type:"string"` // The type of constraint. Use distinctInstance to ensure that each task in // a particular group is running on a different container instance. Use memberOf // to restrict the selection to a group of valid candidates. The value distinctInstance // is not supported in task definitions. Type PlacementConstraintType `locationName:"type" type:"string" enum:"true"` // contains filtered or unexported fields }
An object representing a constraint on task placement. For more information, see Task Placement Constraints (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) in the Amazon Elastic Container Service Developer Guide. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PlacementConstraint
func (PlacementConstraint) GoString ¶
func (s PlacementConstraint) GoString() string
GoString returns the string representation
func (PlacementConstraint) String ¶
func (s PlacementConstraint) String() string
String returns the string representation
type PlacementConstraintType ¶
type PlacementConstraintType string
const ( PlacementConstraintTypeDistinctInstance PlacementConstraintType = "distinctInstance" PlacementConstraintTypeMemberOf PlacementConstraintType = "memberOf" )
Enum values for PlacementConstraintType
func (PlacementConstraintType) MarshalValue ¶
func (enum PlacementConstraintType) MarshalValue() (string, error)
func (PlacementConstraintType) MarshalValueBuf ¶
func (enum PlacementConstraintType) MarshalValueBuf(b []byte) ([]byte, error)
type PlacementStrategy ¶
type PlacementStrategy struct { // The field to apply the placement strategy against. For the spread placement // strategy, valid values are instanceId (or host, which has the same effect), // or any platform or custom attribute that is applied to a container instance, // such as attribute:ecs.availability-zone. For the binpack placement strategy, // valid values are cpu and memory. For the random placement strategy, this // field is not used. Field *string `locationName:"field" type:"string"` // The type of placement strategy. The random placement strategy randomly places // tasks on available candidates. The spread placement strategy spreads placement // across available candidates evenly based on the field parameter. The binpack // strategy places tasks on available candidates that have the least available // amount of the resource that is specified with the field parameter. For example, // if you binpack on memory, a task is placed on the instance with the least // amount of remaining memory (but still enough to run the task). Type PlacementStrategyType `locationName:"type" type:"string" enum:"true"` // contains filtered or unexported fields }
The task placement strategy for a task or service. For more information, see Task Placement Strategies (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html) in the Amazon Elastic Container Service Developer Guide. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PlacementStrategy
func (PlacementStrategy) GoString ¶
func (s PlacementStrategy) GoString() string
GoString returns the string representation
func (PlacementStrategy) String ¶
func (s PlacementStrategy) String() string
String returns the string representation
type PlacementStrategyType ¶
type PlacementStrategyType string
const ( PlacementStrategyTypeRandom PlacementStrategyType = "random" PlacementStrategyTypeSpread PlacementStrategyType = "spread" PlacementStrategyTypeBinpack PlacementStrategyType = "binpack" )
Enum values for PlacementStrategyType
func (PlacementStrategyType) MarshalValue ¶
func (enum PlacementStrategyType) MarshalValue() (string, error)
func (PlacementStrategyType) MarshalValueBuf ¶
func (enum PlacementStrategyType) MarshalValueBuf(b []byte) ([]byte, error)
type PortMapping ¶
type PortMapping struct { // The port number on the container that is bound to the user-specified or automatically // assigned host port. // // If using containers in a task with the awsvpc or host network mode, exposed // ports should be specified using containerPort. // // If using containers in a task with the bridge network mode and 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). // Port mappings that are automatically assigned in this way do not count toward // the 100 reserved ports limit of a container instance. ContainerPort *int64 `locationName:"containerPort" type:"integer"` // The port number on the container instance to reserve for your container. // // If using containers in a task with the awsvpc or host network mode, the hostPort // can either be left blank or set to the same value as the containerPort. // // If using containers in a task with the bridge network mode, 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 for Docker version 1.6.0 and later is listed // on the instance under /proc/sys/net/ipv4/ip_local_port_range; if this kernel // parameter is unavailable, the default ephemeral port range from 49153 through // 65535 is used. You should not attempt to specify a host port in the ephemeral // port range as these are reserved for automatic assignment. In general, ports // below 32768 are outside of the ephemeral port range. // // The default ephemeral port range from 49153 through 65535 is always used // for Docker versions before 1.6.0. // // The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, // and the Amazon ECS container agent ports 51678 and 51679. 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 100 reserved ports at a time, // including the default reserved ports (automatically assigned ports do not // count toward the 100 reserved ports 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 TransportProtocol `locationName:"protocol" type:"string" enum:"true"` // 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.
If using containers in a task with the awsvpc or host network mode, exposed ports should be specified using containerPort. The hostPort can be left blank or it must be the same value as the containerPort.
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. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PortMapping
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 PutAttributesInput ¶
type PutAttributesInput struct { // The attributes to apply to your resource. You can specify up to 10 custom // attributes per resource. You can specify up to 10 attributes in a single // call. // // Attributes is a required field Attributes []Attribute `locationName:"attributes" type:"list" required:"true"` // The short name or full Amazon Resource Name (ARN) of the cluster that contains // the resource to apply attributes. If you do not specify a cluster, the default // cluster is assumed. Cluster *string `locationName:"cluster" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PutAttributesRequest
func (PutAttributesInput) GoString ¶
func (s PutAttributesInput) GoString() string
GoString returns the string representation
func (PutAttributesInput) String ¶
func (s PutAttributesInput) String() string
String returns the string representation
func (*PutAttributesInput) Validate ¶
func (s *PutAttributesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutAttributesOutput ¶
type PutAttributesOutput struct { // The attributes applied to your resource. Attributes []Attribute `locationName:"attributes" type:"list"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/PutAttributesResponse
func (PutAttributesOutput) GoString ¶
func (s PutAttributesOutput) GoString() string
GoString returns the string representation
func (PutAttributesOutput) SDKResponseMetadata ¶
func (s PutAttributesOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (PutAttributesOutput) String ¶
func (s PutAttributesOutput) String() string
String returns the string representation
type PutAttributesRequest ¶
type PutAttributesRequest struct { *aws.Request Input *PutAttributesInput Copy func(*PutAttributesInput) PutAttributesRequest }
PutAttributesRequest is a API request type for the PutAttributes API operation.
func (PutAttributesRequest) Send ¶
func (r PutAttributesRequest) Send() (*PutAttributesOutput, error)
Send marshals and sends the PutAttributes API request.
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 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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RegisterContainerInstanceRequest
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 { // The container instance that was registered. ContainerInstance *ContainerInstance `locationName:"containerInstance" type:"structure"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RegisterContainerInstanceResponse
func (RegisterContainerInstanceOutput) GoString ¶
func (s RegisterContainerInstanceOutput) GoString() string
GoString returns the string representation
func (RegisterContainerInstanceOutput) SDKResponseMetadata ¶
func (s RegisterContainerInstanceOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (RegisterContainerInstanceOutput) String ¶
func (s RegisterContainerInstanceOutput) String() string
String returns the string representation
type RegisterContainerInstanceRequest ¶
type RegisterContainerInstanceRequest struct { *aws.Request Input *RegisterContainerInstanceInput Copy func(*RegisterContainerInstanceInput) RegisterContainerInstanceRequest }
RegisterContainerInstanceRequest is a API request type for the RegisterContainerInstance API operation.
func (RegisterContainerInstanceRequest) Send ¶
func (r RegisterContainerInstanceRequest) Send() (*RegisterContainerInstanceOutput, error)
Send marshals and sends the RegisterContainerInstance API request.
type RegisterTaskDefinitionInput ¶
type RegisterTaskDefinitionInput struct { // A list of container definitions in JSON format that describe the different // containers that make up your task. // // ContainerDefinitions is a required field ContainerDefinitions []ContainerDefinition `locationName:"containerDefinitions" type:"list" required:"true"` // The number of CPU units used by the task. It can be expressed as an integer // using CPU units, for example 1024, or as a string using vCPUs, for example // 1 vCPU or 1 vcpu, in a task definition but will be converted to an integer // indicating the CPU units when the task definition is registered. // // Task-level CPU and memory parameters are ignored for Windows containers. // We recommend specifying container-level resources for Windows containers. // // If using the EC2 launch type, this field is optional. Supported values are // between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs). // // If using the Fargate launch type, this field is required and you must use // one of the following values, which determines your range of supported values // for the memory parameter: // // * 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), // 2048 (2 GB) // // * 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 // (3 GB), 4096 (4 GB) // // * 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 // (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) // // * 2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 // (16 GB) in increments of 1024 (1 GB) // // * 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 // (30 GB) in increments of 1024 (1 GB) Cpu *string `locationName:"cpu" type:"string"` // The Amazon Resource Name (ARN) of the task execution role that the Amazon // ECS container agent and the Docker daemon can assume. ExecutionRoleArn *string `locationName:"executionRoleArn" type:"string"` // 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 is a required field Family *string `locationName:"family" type:"string" required:"true"` // The amount of memory (in MiB) used by the task. It can be expressed as an // integer using MiB, for example 1024, or as a string using GB, for example // 1GB or 1 GB, in a task definition but will be converted to an integer indicating // the MiB when the task definition is registered. // // Task-level CPU and memory parameters are ignored for Windows containers. // We recommend specifying container-level resources for Windows containers. // // If using the EC2 launch type, this field is optional. // // If using the Fargate launch type, this field is required and you must use // one of the following values, which determines your range of supported values // for the cpu parameter: // // * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 // vCPU) // // * 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: // 512 (.5 vCPU) // // * 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 // (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU) // // * Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - // Available cpu values: 2048 (2 vCPU) // // * Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - // Available cpu values: 4096 (4 vCPU) Memory *string `locationName:"memory" type:"string"` // The Docker networking mode to use for the containers in the task. The valid // values are none, bridge, awsvpc, and host. The default Docker network mode // is bridge. If using the Fargate launch type, the awsvpc network mode is required. // If using the EC2 launch type, any network mode can be used. If the network // mode is set to none, you can't specify port mappings in your container definitions, // and the task's containers do not have external connectivity. The host and // awsvpc network modes offer the highest networking performance for containers // because they use the EC2 network stack instead of the virtualized network // stack provided by the bridge mode. // // With the host and awsvpc network modes, exposed container ports are mapped // directly to the corresponding host port (for the host network mode) or the // attached elastic network interface port (for the awsvpc network mode), so // you cannot take advantage of dynamic host port mappings. // // If the network mode is awsvpc, the task is allocated an Elastic Network Interface, // and you must specify a NetworkConfiguration when you create a service or // run a task with the task definition. For more information, see Task Networking // (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) // in the Amazon Elastic Container Service Developer Guide. // // If the network mode is host, you can't run multiple instantiations of the // same task on a single container instance when port mappings are used. // // Docker for Windows uses different network modes than Docker for Linux. When // you register a task definition with Windows containers, you must not specify // a network mode. // // For more information, see Network settings (https://docs.docker.com/engine/reference/run/#network-settings) // in the Docker run reference. NetworkMode NetworkMode `locationName:"networkMode" type:"string" enum:"true"` // An array of placement constraint objects to use for the task. You can specify // a maximum of 10 constraints per task (this limit includes constraints in // the task definition and those specified at run time). PlacementConstraints []TaskDefinitionPlacementConstraint `locationName:"placementConstraints" type:"list"` // The launch type required by the task. If no value is specified, it defaults // to EC2. RequiresCompatibilities []Compatibility `locationName:"requiresCompatibilities" type:"list"` // The short name or full Amazon Resource Name (ARN) of the IAM role that containers // in this task can assume. All containers in this task are granted the permissions // that are specified in this role. For more information, see IAM Roles for // Tasks (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) // in the Amazon Elastic Container Service Developer Guide. TaskRoleArn *string `locationName:"taskRoleArn" type:"string"` // 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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RegisterTaskDefinitionRequest
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RegisterTaskDefinitionResponse
func (RegisterTaskDefinitionOutput) GoString ¶
func (s RegisterTaskDefinitionOutput) GoString() string
GoString returns the string representation
func (RegisterTaskDefinitionOutput) SDKResponseMetadata ¶
func (s RegisterTaskDefinitionOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (RegisterTaskDefinitionOutput) String ¶
func (s RegisterTaskDefinitionOutput) String() string
String returns the string representation
type RegisterTaskDefinitionRequest ¶
type RegisterTaskDefinitionRequest struct { *aws.Request Input *RegisterTaskDefinitionInput Copy func(*RegisterTaskDefinitionInput) RegisterTaskDefinitionRequest }
RegisterTaskDefinitionRequest is a API request type for the RegisterTaskDefinition API operation.
func (RegisterTaskDefinitionRequest) Send ¶
func (r RegisterTaskDefinitionRequest) Send() (*RegisterTaskDefinitionOutput, error)
Send marshals and sends the RegisterTaskDefinition API request.
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, PORTS_UDP, 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/Resource
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. // You can specify up to 10 tasks per call. Count *int64 `locationName:"count" type:"integer"` // The name of the task group to associate with the task. The default value // is the family name of the task definition (for example, family:my-family-name). Group *string `locationName:"group" type:"string"` // The launch type on which to run your task. LaunchType LaunchType `locationName:"launchType" type:"string" enum:"true"` // The network configuration for the task. This parameter is required for task // definitions that use the awsvpc network mode to receive their own Elastic // Network Interface, and it is not supported for other network modes. For more // information, see Task Networking (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) // in the Amazon Elastic Container Service Developer Guide. NetworkConfiguration *NetworkConfiguration `locationName:"networkConfiguration" type:"structure"` // 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 array of placement constraint objects to use for the task. You can specify // up to 10 constraints per task (including constraints in the task definition // and those specified at run time). PlacementConstraints []PlacementConstraint `locationName:"placementConstraints" type:"list"` // The placement strategy objects to use for the task. You can specify a maximum // of five strategy rules per task. PlacementStrategy []PlacementStrategy `locationName:"placementStrategy" type:"list"` // The platform version on which to run your task. If one is not specified, // the latest version is used by default. PlatformVersion *string `locationName:"platformVersion" type:"string"` // 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. Up to 36 letters (uppercase and lowercase), numbers, // hyphens, and underscores are allowed. // // 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 ARN of the task definition // to run. If a revision is not specified, the latest ACTIVE revision is used. // // TaskDefinition is a required field TaskDefinition *string `locationName:"taskDefinition" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RunTaskRequest
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. The tasks that were successfully // placed on your cluster are described here. Tasks []Task `locationName:"tasks" type:"list"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/RunTaskResponse
func (RunTaskOutput) GoString ¶
func (s RunTaskOutput) GoString() string
GoString returns the string representation
func (RunTaskOutput) SDKResponseMetadata ¶
func (s RunTaskOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (RunTaskOutput) String ¶
func (s RunTaskOutput) String() string
String returns the string representation
type RunTaskRequest ¶
type RunTaskRequest struct { *aws.Request Input *RunTaskInput Copy func(*RunTaskInput) RunTaskRequest }
RunTaskRequest is a API request type for the RunTask API operation.
func (RunTaskRequest) Send ¶
func (r RunTaskRequest) Send() (*RunTaskOutput, error)
Send marshals and sends the RunTask API request.
type Service ¶
type Service struct { // The Amazon Resource Name (ARN) of the cluster that hosts the service. ClusterArn *string `locationName:"clusterArn" type:"string"` // The Unix time stamp for when the service was created. CreatedAt *time.Time `locationName:"createdAt" type:"timestamp" timestampFormat:"unix"` // 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"` // The period of time, in seconds, that the Amazon ECS service scheduler ignores // unhealthy Elastic Load Balancing target health checks after a task has first // started. HealthCheckGracePeriodSeconds *int64 `locationName:"healthCheckGracePeriodSeconds" type:"integer"` // The launch type on which your service is running. LaunchType LaunchType `locationName:"launchType" type:"string" enum:"true"` // A list of Elastic Load Balancing 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. // // Services with tasks that use the awsvpc network mode (for example, those // with the Fargate launch type) only support Application Load Balancers and // Network Load Balancers; Classic Load Balancers are not supported. Also, when // you create any target groups for these services, you must choose ip as the // target type, not instance, because tasks that use the awsvpc network mode // are associated with an elastic network interface, not an Amazon EC2 instance. LoadBalancers []LoadBalancer `locationName:"loadBalancers" type:"list"` // The VPC subnet and security group configuration for tasks that receive their // own Elastic Network Interface by using the awsvpc networking mode. NetworkConfiguration *NetworkConfiguration `locationName:"networkConfiguration" type:"structure"` // The number of tasks in the cluster that are in the PENDING state. PendingCount *int64 `locationName:"pendingCount" type:"integer"` // The placement constraints for the tasks in the service. PlacementConstraints []PlacementConstraint `locationName:"placementConstraints" type:"list"` // The placement strategy that determines how tasks for the service are placed. PlacementStrategy []PlacementStrategy `locationName:"placementStrategy" type:"list"` // The platform version on which your task is running. For more information, // see AWS Fargate Platform Versions (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) // in the Amazon Elastic Container Service Developer Guide. PlatformVersion *string `locationName:"platformVersion" type:"string"` // The ARN of the IAM role associated with the service that allows the Amazon // ECS container agent to register container instances with an Elastic Load // Balancing 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 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"` ServiceRegistries []ServiceRegistry `locationName:"serviceRegistries" type:"list"` // 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 Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/Service
type ServiceEvent ¶
type ServiceEvent struct { // The Unix time stamp for 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceEvent
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 ServiceRegistry ¶
type ServiceRegistry struct { // The container name value, already specified in the task definition, to be // used for your service discovery service. If the task definition that your // service task specifies uses the bridge or host network mode, you must specify // a containerName and containerPort combination from the task definition. If // the task definition that your service task specifies uses the awsvpc network // mode and a type SRV DNS record is used, you must specify either a containerName // and containerPort combination or a port value, but not both. ContainerName *string `locationName:"containerName" type:"string"` // The port value, already specified in the task definition, to be used for // your service discovery service. If the task definition your service task // specifies uses the bridge or host network mode, you must specify a containerName // and containerPort combination from the task definition. If the task definition // your service task specifies uses the awsvpc network mode and a type SRV DNS // record is used, you must specify either a containerName and containerPort // combination or a port value, but not both. ContainerPort *int64 `locationName:"containerPort" type:"integer"` // The port value used if your service discovery service specified an SRV record. // This field is required if both the awsvpc network mode and SRV records are // used. Port *int64 `locationName:"port" type:"integer"` // The Amazon Resource Name (ARN) of the service registry. The currently supported // service registry is Amazon Route 53 Auto Naming. For more information, see // Service (https://docs.aws.amazon.com/Route53/latest/APIReference/API_autonaming_Service.html). RegistryArn *string `locationName:"registryArn" type:"string"` // contains filtered or unexported fields }
Details of the service registry. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ServiceRegistry
func (ServiceRegistry) GoString ¶
func (s ServiceRegistry) GoString() string
GoString returns the string representation
func (ServiceRegistry) String ¶
func (s ServiceRegistry) 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 ARN entries for the container instances // on which you would like to place your task. You can specify up to 10 container // instances. // // ContainerInstances is a required field ContainerInstances []string `locationName:"containerInstances" type:"list" required:"true"` // The name of the task group to associate with the task. The default value // is the family name of the task definition (for example, family:my-family-name). Group *string `locationName:"group" type:"string"` // The VPC subnet and security group configuration for tasks that receive their // own Elastic Network Interface by using the awsvpc networking mode. NetworkConfiguration *NetworkConfiguration `locationName:"networkConfiguration" type:"structure"` // 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. Up to 36 letters (uppercase and lowercase), numbers, // hyphens, and underscores are allowed. // // 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 ARN of the task definition // to start. If a revision is not specified, the latest ACTIVE revision is used. // // TaskDefinition is a required field TaskDefinition *string `locationName:"taskDefinition" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/StartTaskRequest
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 is described. Tasks []Task `locationName:"tasks" type:"list"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/StartTaskResponse
func (StartTaskOutput) GoString ¶
func (s StartTaskOutput) GoString() string
GoString returns the string representation
func (StartTaskOutput) SDKResponseMetadata ¶
func (s StartTaskOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (StartTaskOutput) String ¶
func (s StartTaskOutput) String() string
String returns the string representation
type StartTaskRequest ¶
type StartTaskRequest struct { *aws.Request Input *StartTaskInput Copy func(*StartTaskInput) StartTaskRequest }
StartTaskRequest is a API request type for the StartTask API operation.
func (StartTaskRequest) Send ¶
func (r StartTaskRequest) Send() (*StartTaskOutput, error)
Send marshals and sends the StartTask API request.
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 appears 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 ARN entry of the task to stop. // // Task is a required field Task *string `locationName:"task" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/StopTaskRequest
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 { // The task that was stopped. Task *Task `locationName:"task" type:"structure"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/StopTaskResponse
func (StopTaskOutput) GoString ¶
func (s StopTaskOutput) GoString() string
GoString returns the string representation
func (StopTaskOutput) SDKResponseMetadata ¶
func (s StopTaskOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (StopTaskOutput) String ¶
func (s StopTaskOutput) String() string
String returns the string representation
type StopTaskRequest ¶
type StopTaskRequest struct { *aws.Request Input *StopTaskInput Copy func(*StopTaskInput) StopTaskRequest }
StopTaskRequest is a API request type for the StopTask API operation.
func (StopTaskRequest) Send ¶
func (r StopTaskRequest) Send() (*StopTaskOutput, error)
Send marshals and sends the StopTask API request.
type SubmitContainerStateChangeInput ¶
type SubmitContainerStateChangeInput struct { // The short name or full 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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/SubmitContainerStateChangeRequest
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/SubmitContainerStateChangeResponse
func (SubmitContainerStateChangeOutput) GoString ¶
func (s SubmitContainerStateChangeOutput) GoString() string
GoString returns the string representation
func (SubmitContainerStateChangeOutput) SDKResponseMetadata ¶
func (s SubmitContainerStateChangeOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (SubmitContainerStateChangeOutput) String ¶
func (s SubmitContainerStateChangeOutput) String() string
String returns the string representation
type SubmitContainerStateChangeRequest ¶
type SubmitContainerStateChangeRequest struct { *aws.Request Input *SubmitContainerStateChangeInput Copy func(*SubmitContainerStateChangeInput) SubmitContainerStateChangeRequest }
SubmitContainerStateChangeRequest is a API request type for the SubmitContainerStateChange API operation.
func (SubmitContainerStateChangeRequest) Send ¶
func (r SubmitContainerStateChangeRequest) Send() (*SubmitContainerStateChangeOutput, error)
Send marshals and sends the SubmitContainerStateChange API request.
type SubmitTaskStateChangeInput ¶
type SubmitTaskStateChangeInput struct { // Any attachments associated with the state change request. Attachments []AttachmentStateChange `locationName:"attachments" type:"list"` // The short name or full Amazon Resource Name (ARN) of the cluster that hosts // the task. Cluster *string `locationName:"cluster" type:"string"` // Any containers associated with the state change request. Containers []ContainerStateChange `locationName:"containers" type:"list"` // The Unix time stamp for when the task execution stopped. ExecutionStoppedAt *time.Time `locationName:"executionStoppedAt" type:"timestamp" timestampFormat:"unix"` // The Unix time stamp for when the container image pull began. PullStartedAt *time.Time `locationName:"pullStartedAt" type:"timestamp" timestampFormat:"unix"` // The Unix time stamp for when the container image pull completed. PullStoppedAt *time.Time `locationName:"pullStoppedAt" type:"timestamp" timestampFormat:"unix"` // 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 ARN of the task in the state change request. Task *string `locationName:"task" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/SubmitTaskStateChangeRequest
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
func (*SubmitTaskStateChangeInput) Validate ¶
func (s *SubmitTaskStateChangeInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type SubmitTaskStateChangeOutput ¶
type SubmitTaskStateChangeOutput struct { // Acknowledgement of the state change. Acknowledgment *string `locationName:"acknowledgment" type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/SubmitTaskStateChangeResponse
func (SubmitTaskStateChangeOutput) GoString ¶
func (s SubmitTaskStateChangeOutput) GoString() string
GoString returns the string representation
func (SubmitTaskStateChangeOutput) SDKResponseMetadata ¶
func (s SubmitTaskStateChangeOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (SubmitTaskStateChangeOutput) String ¶
func (s SubmitTaskStateChangeOutput) String() string
String returns the string representation
type SubmitTaskStateChangeRequest ¶
type SubmitTaskStateChangeRequest struct { *aws.Request Input *SubmitTaskStateChangeInput Copy func(*SubmitTaskStateChangeInput) SubmitTaskStateChangeRequest }
SubmitTaskStateChangeRequest is a API request type for the SubmitTaskStateChange API operation.
func (SubmitTaskStateChangeRequest) Send ¶
func (r SubmitTaskStateChangeRequest) Send() (*SubmitTaskStateChangeOutput, error)
Send marshals and sends the SubmitTaskStateChange API request.
type TargetType ¶
type TargetType string
const (
TargetTypeContainerInstance TargetType = "container-instance"
)
Enum values for TargetType
func (TargetType) MarshalValue ¶
func (enum TargetType) MarshalValue() (string, error)
func (TargetType) MarshalValueBuf ¶
func (enum TargetType) MarshalValueBuf(b []byte) ([]byte, error)
type Task ¶
type Task struct { // The Elastic Network Adapter associated with the task if the task uses the // awsvpc network mode. Attachments []Attachment `locationName:"attachments" type:"list"` // The ARN of the cluster that hosts the task. ClusterArn *string `locationName:"clusterArn" type:"string"` // The connectivity status of a task. Connectivity Connectivity `locationName:"connectivity" type:"string" enum:"true"` // The Unix time stamp for when the task last went into CONNECTED status. ConnectivityAt *time.Time `locationName:"connectivityAt" type:"timestamp" timestampFormat:"unix"` // The 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 number of CPU units used by the task. It can be expressed as an integer // using CPU units, for example 1024, or as a string using vCPUs, for example // 1 vCPU or 1 vcpu, in a task definition but is converted to an integer indicating // the CPU units when the task definition is registered. // // If using the EC2 launch type, this field is optional. Supported values are // between 128 CPU units (0.125 vCPUs) and 10240 CPU units (10 vCPUs). // // If using the Fargate launch type, this field is required and you must use // one of the following values, which determines your range of supported values // for the memory parameter: // // * 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), // 2048 (2 GB) // // * 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 // (3 GB), 4096 (4 GB) // // * 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 // (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) // // * 2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 // (16 GB) in increments of 1024 (1 GB) // // * 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 // (30 GB) in increments of 1024 (1 GB) Cpu *string `locationName:"cpu" type:"string"` // The Unix time stamp for 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 Unix time stamp for when the task execution stopped. ExecutionStoppedAt *time.Time `locationName:"executionStoppedAt" type:"timestamp" timestampFormat:"unix"` // The name of the task group associated with the task. Group *string `locationName:"group" type:"string"` // The health status for the task, which is determined by the health of the // essential containers in the task. If all essential containers in the task // are reporting as HEALTHY, then the task status also reports as HEALTHY. If // any essential containers in the task are reporting as UNHEALTHY or UNKNOWN, // then the task status also reports as UNHEALTHY or UNKNOWN, accordingly. // // The Amazon ECS container agent does not monitor or report on Docker health // checks that are embedded in a container image (such as those specified in // a parent image or from the image's Dockerfile) and not specified in the container // definition. Health check parameters that are specified in a container definition // override any Docker health checks that exist in the container image. HealthStatus HealthStatus `locationName:"healthStatus" type:"string" enum:"true"` // The last known status of the task. LastStatus *string `locationName:"lastStatus" type:"string"` // The launch type on which your task is running. LaunchType LaunchType `locationName:"launchType" type:"string" enum:"true"` // The amount of memory (in MiB) used by the task. It can be expressed as an // integer using MiB, for example 1024, or as a string using GB, for example // 1GB or 1 GB, in a task definition but is converted to an integer indicating // the MiB when the task definition is registered. // // If using the EC2 launch type, this field is optional. // // If using the Fargate launch type, this field is required and you must use // one of the following values, which determines your range of supported values // for the cpu parameter: // // * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 // vCPU) // // * 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: // 512 (.5 vCPU) // // * 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 // (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU) // // * Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - // Available cpu values: 2048 (2 vCPU) // // * Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - // Available cpu values: 4096 (4 vCPU) Memory *string `locationName:"memory" type:"string"` // One or more container overrides. Overrides *TaskOverride `locationName:"overrides" type:"structure"` // The platform version on which your task is running. For more information, // see AWS Fargate Platform Versions (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) // in the Amazon Elastic Container Service Developer Guide. PlatformVersion *string `locationName:"platformVersion" type:"string"` // The Unix time stamp for when the container image pull began. PullStartedAt *time.Time `locationName:"pullStartedAt" type:"timestamp" timestampFormat:"unix"` // The Unix time stamp for when the container image pull completed. PullStoppedAt *time.Time `locationName:"pullStoppedAt" type:"timestamp" timestampFormat:"unix"` // The Unix time stamp for when the task 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 stamp for 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 Unix time stamp for when the task will stop (transitions from the RUNNING // state to STOPPED). StoppingAt *time.Time `locationName:"stoppingAt" type:"timestamp" timestampFormat:"unix"` // The Amazon Resource Name (ARN) of the task. TaskArn *string `locationName:"taskArn" type:"string"` // The ARN of the task definition that creates the task. TaskDefinitionArn *string `locationName:"taskDefinitionArn" type:"string"` // The version counter for the task. Every time a task experiences a change // that triggers a CloudWatch event, the version counter is incremented. If // you are replicating your Amazon ECS task state with CloudWatch Events, you // can compare the version of a task reported by the Amazon ECS APIs with the // version reported in CloudWatch Events for the task (inside the detail object) // to verify that the version in your event stream is current. Version *int64 `locationName:"version" type:"long"` // contains filtered or unexported fields }
Details on a task in a cluster. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/Task
type TaskDefinition ¶
type TaskDefinition struct { // The launch type to use with your task. For more information, see Amazon ECS // Launch Types (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) // in the Amazon Elastic Container Service Developer Guide. Compatibilities []Compatibility `locationName:"compatibilities" type:"list"` // 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 Elastic Container Service Developer Guide. ContainerDefinitions []ContainerDefinition `locationName:"containerDefinitions" type:"list"` // The number of cpu units used by the task. If using the EC2 launch type, this // field is optional and any value can be used. If using the Fargate launch // type, this field is required and you must use one of the following values, // which determines your range of valid values for the memory parameter: // // * 256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), // 2048 (2 GB) // // * 512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 // (3 GB), 4096 (4 GB) // // * 1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 // (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) // // * 2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 // (16 GB) in increments of 1024 (1 GB) // // * 4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 // (30 GB) in increments of 1024 (1 GB) Cpu *string `locationName:"cpu" type:"string"` // The Amazon Resource Name (ARN) of the task execution role that the Amazon // ECS container agent and the Docker daemon can assume. ExecutionRoleArn *string `locationName:"executionRoleArn" type:"string"` // The family of your task definition, used as the definition name. Family *string `locationName:"family" type:"string"` // The amount (in MiB) of memory used by the task. If using the EC2 launch type, // this field is optional and any value can be used. If using the Fargate launch // type, this field is required and you must use one of the following values, // which determines your range of valid values for the cpu parameter: // // * 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 // vCPU) // // * 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: // 512 (.5 vCPU) // // * 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 // (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU) // // * Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - // Available cpu values: 2048 (2 vCPU) // // * Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - // Available cpu values: 4096 (4 vCPU) Memory *string `locationName:"memory" type:"string"` // The Docker networking mode to use for the containers in the task. The valid // values are none, bridge, awsvpc, and host. The default Docker network mode // is bridge. If using the Fargate launch type, the awsvpc network mode is required. // If using the EC2 launch type, any network mode can be used. If the network // mode is set to none, you can't specify port mappings in your container definitions, // and the task's containers do not have external connectivity. The host and // awsvpc network modes offer the highest networking performance for containers // because they use the EC2 network stack instead of the virtualized network // stack provided by the bridge mode. // // With the host and awsvpc network modes, exposed container ports are mapped // directly to the corresponding host port (for the host network mode) or the // attached elastic network interface port (for the awsvpc network mode), so // you cannot take advantage of dynamic host port mappings. // // If the network mode is awsvpc, the task is allocated an Elastic Network Interface, // and you must specify a NetworkConfiguration when you create a service or // run a task with the task definition. For more information, see Task Networking // (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) // in the Amazon Elastic Container Service Developer Guide. // // Currently, only the Amazon ECS-optimized AMI, other Amazon Linux variants // with the ecs-init package, or AWS Fargate infrastructure support the awsvpc // network mode. // // If the network mode is host, you can't run multiple instantiations of the // same task on a single container instance when port mappings are used. // // Docker for Windows uses different network modes than Docker for Linux. When // you register a task definition with Windows containers, you must not specify // a network mode. If you use the console to register a task definition with // Windows containers, you must choose the <default> network mode object. // // For more information, see Network settings (https://docs.docker.com/engine/reference/run/#network-settings) // in the Docker run reference. NetworkMode NetworkMode `locationName:"networkMode" type:"string" enum:"true"` // An array of placement constraint objects to use for tasks. This field is // not valid if using the Fargate launch type for your task. PlacementConstraints []TaskDefinitionPlacementConstraint `locationName:"placementConstraints" type:"list"` // The container instance attributes required by your task. This field is not // valid if using the Fargate launch type for your task. RequiresAttributes []Attribute `locationName:"requiresAttributes" type:"list"` // The launch type the task is using. RequiresCompatibilities []Compatibility `locationName:"requiresCompatibilities" 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 TaskDefinitionStatus `locationName:"status" type:"string" enum:"true"` // The full Amazon Resource Name (ARN) of the task definition. TaskDefinitionArn *string `locationName:"taskDefinitionArn" type:"string"` // The ARN of the IAM role that containers in this task can assume. All containers // in this task are granted the permissions that are specified in this role. // // IAM roles for tasks on Windows require that the -EnableTaskIAMRole option // is set when you launch the Amazon ECS-optimized Windows AMI. Your containers // must also run some configuration code in order to take advantage of the feature. // For more information, see Windows IAM Roles for Tasks (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html) // in the Amazon Elastic Container Service Developer Guide. TaskRoleArn *string `locationName:"taskRoleArn" type:"string"` // The list of volumes in a task. // // If you are using the Fargate launch type, the host and sourcePath parameters // are not supported. // // For more information about volume definition parameters and defaults, see // Amazon ECS Task Definitions (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html) // in the Amazon Elastic Container Service Developer Guide. Volumes []Volume `locationName:"volumes" type:"list"` // contains filtered or unexported fields }
Details of a task definition. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/TaskDefinition
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 TaskDefinitionFamilyStatus ¶
type TaskDefinitionFamilyStatus string
const ( TaskDefinitionFamilyStatusActive TaskDefinitionFamilyStatus = "ACTIVE" TaskDefinitionFamilyStatusInactive TaskDefinitionFamilyStatus = "INACTIVE" TaskDefinitionFamilyStatusAll TaskDefinitionFamilyStatus = "ALL" )
Enum values for TaskDefinitionFamilyStatus
func (TaskDefinitionFamilyStatus) MarshalValue ¶
func (enum TaskDefinitionFamilyStatus) MarshalValue() (string, error)
func (TaskDefinitionFamilyStatus) MarshalValueBuf ¶
func (enum TaskDefinitionFamilyStatus) MarshalValueBuf(b []byte) ([]byte, error)
type TaskDefinitionPlacementConstraint ¶
type TaskDefinitionPlacementConstraint struct { // A cluster query language expression to apply to the constraint. For more // information, see Cluster Query Language (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) // in the Amazon Elastic Container Service Developer Guide. Expression *string `locationName:"expression" type:"string"` // The type of constraint. The DistinctInstance constraint ensures that each // task in a particular group is running on a different container instance. // The MemberOf constraint restricts selection to be from a group of valid candidates. Type TaskDefinitionPlacementConstraintType `locationName:"type" type:"string" enum:"true"` // contains filtered or unexported fields }
An object representing a constraint on task placement in the task definition.
If you are using the Fargate launch type, task placement constraints are not supported.
For more information, see Task Placement Constraints (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html) in the Amazon Elastic Container Service Developer Guide. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/TaskDefinitionPlacementConstraint
func (TaskDefinitionPlacementConstraint) GoString ¶
func (s TaskDefinitionPlacementConstraint) GoString() string
GoString returns the string representation
func (TaskDefinitionPlacementConstraint) String ¶
func (s TaskDefinitionPlacementConstraint) String() string
String returns the string representation
type TaskDefinitionPlacementConstraintType ¶
type TaskDefinitionPlacementConstraintType string
const (
TaskDefinitionPlacementConstraintTypeMemberOf TaskDefinitionPlacementConstraintType = "memberOf"
)
Enum values for TaskDefinitionPlacementConstraintType
func (TaskDefinitionPlacementConstraintType) MarshalValue ¶
func (enum TaskDefinitionPlacementConstraintType) MarshalValue() (string, error)
func (TaskDefinitionPlacementConstraintType) MarshalValueBuf ¶
func (enum TaskDefinitionPlacementConstraintType) MarshalValueBuf(b []byte) ([]byte, error)
type TaskDefinitionStatus ¶
type TaskDefinitionStatus string
const ( TaskDefinitionStatusActive TaskDefinitionStatus = "ACTIVE" TaskDefinitionStatusInactive TaskDefinitionStatus = "INACTIVE" )
Enum values for TaskDefinitionStatus
func (TaskDefinitionStatus) MarshalValue ¶
func (enum TaskDefinitionStatus) MarshalValue() (string, error)
func (TaskDefinitionStatus) MarshalValueBuf ¶
func (enum TaskDefinitionStatus) MarshalValueBuf(b []byte) ([]byte, error)
type TaskOverride ¶
type TaskOverride struct { // One or more container overrides sent to a task. ContainerOverrides []ContainerOverride `locationName:"containerOverrides" type:"list"` // The Amazon Resource Name (ARN) of the task execution role that the Amazon // ECS container agent and the Docker daemon can assume. ExecutionRoleArn *string `locationName:"executionRoleArn" type:"string"` // The Amazon Resource Name (ARN) of the IAM role that containers in this task // can assume. All containers in this task are granted the permissions that // are specified in this role. TaskRoleArn *string `locationName:"taskRoleArn" type:"string"` // contains filtered or unexported fields }
The overrides associated with a task. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/TaskOverride
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 Tmpfs ¶
type Tmpfs struct { // The absolute file path where the tmpfs volume will be mounted. // // ContainerPath is a required field ContainerPath *string `locationName:"containerPath" type:"string" required:"true"` // The list of tmpfs volume mount options. // // Valid values: "defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" // | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | // "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" // | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" // | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime" MountOptions []string `locationName:"mountOptions" type:"list"` // The size (in MiB) of the tmpfs volume. // // Size is a required field Size *int64 `locationName:"size" type:"integer" required:"true"` // contains filtered or unexported fields }
The container path, mount options, and size of the tmpfs mount. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/Tmpfs
type TransportProtocol ¶
type TransportProtocol string
const ( TransportProtocolTcp TransportProtocol = "tcp" TransportProtocolUdp TransportProtocol = "udp" )
Enum values for TransportProtocol
func (TransportProtocol) MarshalValue ¶
func (enum TransportProtocol) MarshalValue() (string, error)
func (TransportProtocol) MarshalValueBuf ¶
func (enum TransportProtocol) MarshalValueBuf(b []byte) ([]byte, error)
type Ulimit ¶
type Ulimit struct { // The hard limit for the ulimit type. // // HardLimit is a required field HardLimit *int64 `locationName:"hardLimit" type:"integer" required:"true"` // The type of the ulimit. // // Name is a required field Name UlimitName `locationName:"name" type:"string" required:"true" enum:"true"` // The soft limit for the ulimit type. // // SoftLimit is a required field SoftLimit *int64 `locationName:"softLimit" type:"integer" required:"true"` // contains filtered or unexported fields }
The ulimit settings to pass to the container. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/Ulimit
type UlimitName ¶
type UlimitName string
const ( UlimitNameCore UlimitName = "core" UlimitNameCpu UlimitName = "cpu" UlimitNameData UlimitName = "data" UlimitNameFsize UlimitName = "fsize" UlimitNameLocks UlimitName = "locks" UlimitNameMemlock UlimitName = "memlock" UlimitNameMsgqueue UlimitName = "msgqueue" UlimitNameNice UlimitName = "nice" UlimitNameNofile UlimitName = "nofile" UlimitNameNproc UlimitName = "nproc" UlimitNameRss UlimitName = "rss" UlimitNameRtprio UlimitName = "rtprio" UlimitNameRttime UlimitName = "rttime" UlimitNameSigpending UlimitName = "sigpending" UlimitNameStack UlimitName = "stack" )
Enum values for UlimitName
func (UlimitName) MarshalValue ¶
func (enum UlimitName) MarshalValue() (string, error)
func (UlimitName) MarshalValueBuf ¶
func (enum UlimitName) MarshalValueBuf(b []byte) ([]byte, error)
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 ARN entries for the container instance // on which you would like to update the Amazon ECS container agent. // // ContainerInstance is a required field ContainerInstance *string `locationName:"containerInstance" type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateContainerAgentRequest
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 { // The container instance for which the container agent was updated. ContainerInstance *ContainerInstance `locationName:"containerInstance" type:"structure"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateContainerAgentResponse
func (UpdateContainerAgentOutput) GoString ¶
func (s UpdateContainerAgentOutput) GoString() string
GoString returns the string representation
func (UpdateContainerAgentOutput) SDKResponseMetadata ¶
func (s UpdateContainerAgentOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (UpdateContainerAgentOutput) String ¶
func (s UpdateContainerAgentOutput) String() string
String returns the string representation
type UpdateContainerAgentRequest ¶
type UpdateContainerAgentRequest struct { *aws.Request Input *UpdateContainerAgentInput Copy func(*UpdateContainerAgentInput) UpdateContainerAgentRequest }
UpdateContainerAgentRequest is a API request type for the UpdateContainerAgent API operation.
func (UpdateContainerAgentRequest) Send ¶
func (r UpdateContainerAgentRequest) Send() (*UpdateContainerAgentOutput, error)
Send marshals and sends the UpdateContainerAgent API request.
type UpdateContainerInstancesStateInput ¶
type UpdateContainerInstancesStateInput struct { // The short name or full Amazon Resource Name (ARN) of the cluster that hosts // the container instance to update. If you do not specify a cluster, the default // cluster is assumed. Cluster *string `locationName:"cluster" type:"string"` // A list of container instance IDs or full ARN entries. // // ContainerInstances is a required field ContainerInstances []string `locationName:"containerInstances" type:"list" required:"true"` // The container instance state with which to update the container instance. // // Status is a required field Status ContainerInstanceStatus `locationName:"status" type:"string" required:"true" enum:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateContainerInstancesStateRequest
func (UpdateContainerInstancesStateInput) GoString ¶
func (s UpdateContainerInstancesStateInput) GoString() string
GoString returns the string representation
func (UpdateContainerInstancesStateInput) String ¶
func (s UpdateContainerInstancesStateInput) String() string
String returns the string representation
func (*UpdateContainerInstancesStateInput) Validate ¶
func (s *UpdateContainerInstancesStateInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateContainerInstancesStateOutput ¶
type UpdateContainerInstancesStateOutput 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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateContainerInstancesStateResponse
func (UpdateContainerInstancesStateOutput) GoString ¶
func (s UpdateContainerInstancesStateOutput) GoString() string
GoString returns the string representation
func (UpdateContainerInstancesStateOutput) SDKResponseMetadata ¶
func (s UpdateContainerInstancesStateOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (UpdateContainerInstancesStateOutput) String ¶
func (s UpdateContainerInstancesStateOutput) String() string
String returns the string representation
type UpdateContainerInstancesStateRequest ¶
type UpdateContainerInstancesStateRequest struct { *aws.Request Input *UpdateContainerInstancesStateInput Copy func(*UpdateContainerInstancesStateInput) UpdateContainerInstancesStateRequest }
UpdateContainerInstancesStateRequest is a API request type for the UpdateContainerInstancesState API operation.
func (UpdateContainerInstancesStateRequest) Send ¶
func (r UpdateContainerInstancesStateRequest) Send() (*UpdateContainerInstancesStateOutput, error)
Send marshals and sends the UpdateContainerInstancesState API request.
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"` // Whether to force a new deployment of the service. Deployments are not forced // by default. You can use this option to trigger a new deployment with no service // definition changes. For example, you can update a service's tasks to use // a newer Docker image with the same image/tag combination (my_image:latest) // or to roll Fargate tasks onto a newer platform version. ForceNewDeployment *bool `locationName:"forceNewDeployment" type:"boolean"` // The period of time, in seconds, that the Amazon ECS service scheduler should // ignore unhealthy Elastic Load Balancing target health checks after a task // has first started. This is only valid if your service is configured to use // a load balancer. If your service's tasks take a while to start and respond // to Elastic Load Balancing health checks, you can specify a health check grace // period of up to 1,800 seconds during which the ECS service scheduler ignores // the Elastic Load Balancing health check status. This grace period can prevent // the ECS service scheduler from marking tasks as unhealthy and stopping them // before they have time to come up. HealthCheckGracePeriodSeconds *int64 `locationName:"healthCheckGracePeriodSeconds" type:"integer"` // The network configuration for the service. This parameter is required for // task definitions that use the awsvpc network mode to receive their own elastic // network interface, and it is not supported for other network modes. For more // information, see Task Networking (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) // in the Amazon Elastic Container Service Developer Guide. // // Updating a service to add a subnet to a list of existing subnets does not // trigger a service deployment. For example, if your network configuration // change is to keep the existing subnets and simply add another subnet to the // network configuration, this does not trigger a new service deployment. NetworkConfiguration *NetworkConfiguration `locationName:"networkConfiguration" type:"structure"` // The platform version you want to update your service to run. PlatformVersion *string `locationName:"platformVersion" type:"string"` // The name of the service to update. // // Service is a required field Service *string `locationName:"service" type:"string" required:"true"` // The family and revision (family:revision) or full 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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateServiceRequest
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/UpdateServiceResponse
func (UpdateServiceOutput) GoString ¶
func (s UpdateServiceOutput) GoString() string
GoString returns the string representation
func (UpdateServiceOutput) SDKResponseMetadata ¶
func (s UpdateServiceOutput) SDKResponseMetadata() aws.Response
SDKResponseMetdata return sthe response metadata for the API.
func (UpdateServiceOutput) String ¶
func (s UpdateServiceOutput) String() string
String returns the string representation
type UpdateServiceRequest ¶
type UpdateServiceRequest struct { *aws.Request Input *UpdateServiceInput Copy func(*UpdateServiceInput) UpdateServiceRequest }
UpdateServiceRequest is a API request type for the UpdateService API operation.
func (UpdateServiceRequest) Send ¶
func (r UpdateServiceRequest) Send() (*UpdateServiceOutput, error)
Send marshals and sends the UpdateService API request.
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. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/VersionInfo
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. // // Windows containers can mount whole directories on the same drive as $env:ProgramData. // Windows containers cannot mount directories on a different drive, and mount // point cannot be across drives. For example, you can mount C:\my\path:C:\my\path // and D:\:D:\, but not D:\my\path:C:\my\path or D:\:C:\my\path. 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/Volume
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 another container within the same task definition to mount volumes // from. SourceContainer *string `locationName:"sourceContainer" type:"string"` // contains filtered or unexported fields }
Details on a data volume from another container in the same task definition. Please also see https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/VolumeFrom
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