ecs: Amazon EC2 Container Service

Description Usage Arguments Service syntax Operations Examples

View source: R/ecs_service.R

Description

Amazon Elastic 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.

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.

Usage

1
ecs(config = list())

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Service syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
svc <- ecs(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

create_capacity_provider Creates a new capacity provider
create_cluster Creates a new Amazon ECS cluster
create_service Runs and maintains a desired number of tasks from a specified task definition
create_task_set Create a task set in the specified cluster and service
delete_account_setting Disables an account setting for a specified IAM user, IAM role, or the root user for an account
delete_attributes Deletes one or more custom attributes from an Amazon ECS resource
delete_capacity_provider Deletes the specified capacity provider
delete_cluster Deletes the specified cluster
delete_service Deletes a specified service within a cluster
delete_task_set Deletes a specified task set within a service
deregister_container_instance Deregisters an Amazon ECS container instance from the specified cluster
deregister_task_definition Deregisters the specified task definition by family and revision
describe_capacity_providers Describes one or more of your capacity providers
describe_clusters Describes one or more of your clusters
describe_container_instances Describes Amazon Elastic Container Service container instances
describe_services Describes the specified services running in your cluster
describe_task_definition Describes a task definition
describe_tasks Describes a specified task or tasks
describe_task_sets Describes the task sets in the specified cluster and service
discover_poll_endpoint This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent
list_account_settings Lists the account settings for a specified principal
list_attributes Lists the attributes for Amazon ECS resources within a specified target type and cluster
list_clusters Returns a list of existing clusters
list_container_instances Returns a list of container instances in a specified cluster
list_services Lists the services that are running in a specified cluster
list_tags_for_resource List the tags for an Amazon ECS resource
list_task_definition_families 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)
list_task_definitions Returns a list of task definitions that are registered to your account
list_tasks Returns a list of tasks for a specified cluster
put_account_setting Modifies an account setting
put_account_setting_default Modifies an account setting for all IAM users on an account for whom no individual account setting has been specified
put_attributes Create or update an attribute on an Amazon ECS resource
put_cluster_capacity_providers Modifies the available capacity providers and the default capacity provider strategy for a cluster
register_container_instance This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent
register_task_definition Registers a new task definition from the supplied family and containerDefinitions
run_task Starts a new task using the specified task definition
start_task Starts a new task from the specified task definition on the specified container instance or instances
stop_task Stops a running task
submit_attachment_state_changes This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent
submit_container_state_change This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent
submit_task_state_change This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent
tag_resource Associates the specified tags to a resource with the specified resourceArn
untag_resource Deletes specified tags from a resource
update_capacity_provider Modifies the parameters for a capacity provider
update_cluster_settings Modifies the settings to use for a cluster
update_container_agent Updates the Amazon ECS container agent on a specified container instance
update_container_instances_state Modifies the status of an Amazon ECS container instance
update_service Updating the task placement strategies and constraints on an Amazon ECS service remains in preview and is a Beta Service as defined by and subject to the Beta Service Participation Service Terms located at https://aws
update_service_primary_task_set Modifies which task set in a service is the primary task set
update_task_set Modifies a task set

Examples

1
2
3
4
5
6
7
8
## Not run: 
svc <- ecs()
# This example creates a cluster in your default region.
svc$create_cluster(
  clusterName = "my_cluster"
)

## End(Not run)

paws.compute documentation built on March 7, 2021, 5:10 p.m.