CommonTaskDefinitionProps

class aws_cdk.aws_ecs.CommonTaskDefinitionProps(*, execution_role=None, family=None, proxy_configuration=None, task_role=None, volumes=None)

Bases: object

__init__(*, execution_role=None, family=None, proxy_configuration=None, task_role=None, volumes=None)

The common properties for all task definitions.

For more information, see Task Definition Parameters.

Parameters
  • execution_role (Optional[IRole]) – The name of the IAM task execution role that grants the ECS agent to call AWS APIs on your behalf. The role will be used to retrieve container images from ECR and create CloudWatch log groups. Default: - An execution role will be automatically created if you use ECR images in your task definition.

  • family (Optional[str]) – The name of a family that this task definition is registered to. A family groups multiple versions of a task definition. Default: - Automatically generated name.

  • proxy_configuration (Optional[ProxyConfiguration]) – The configuration details for the App Mesh proxy. Default: - No proxy configuration.

  • task_role (Optional[IRole]) – The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf. Default: - A task role is automatically created for you.

  • volumes (Optional[List[Volume]]) – The list of volume definitions for the task. For more information, see Task Definition Parameter Volumes. Default: - No volumes are passed to the Docker daemon on a container instance.

Attributes

execution_role

The name of the IAM task execution role that grants the ECS agent to call AWS APIs on your behalf.

The role will be used to retrieve container images from ECR and create CloudWatch log groups.

default :default: - An execution role will be automatically created if you use ECR images in your task definition.

Return type

Optional[IRole]

family

The name of a family that this task definition is registered to.

A family groups multiple versions of a task definition.

default :default: - Automatically generated name.

Return type

Optional[str]

proxy_configuration

The configuration details for the App Mesh proxy.

default :default: - No proxy configuration.

Return type

Optional[ProxyConfiguration]

task_role

The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf.

default :default: - A task role is automatically created for you.

Return type

Optional[IRole]

volumes

The list of volume definitions for the task.

For more information, see Task Definition Parameter Volumes.

default :default: - No volumes are passed to the Docker daemon on a container instance.

Return type

Optional[List[Volume]]