Network.AWS.ECS.RegisterTaskDefinition

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 in the Amazon EC2 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 in the Amazon EC2 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 in the Docker run reference.

Creating a Request

registerTaskDefinition

Arguments

:: Text

rtdFamily

-> RegisterTaskDefinition

Creates a value of RegisterTaskDefinition with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rtdTaskRoleARN
• rtdNetworkMode
• rtdVolumes
• rtdFamily
• rtdContainerDefinitions

data RegisterTaskDefinition

See: registerTaskDefinition smart constructor.

Instances

Eq RegisterTaskDefinition

Methods

(==) :: RegisterTaskDefinition -> RegisterTaskDefinition -> Bool

(/=) :: RegisterTaskDefinition -> RegisterTaskDefinition -> Bool

Data RegisterTaskDefinition

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RegisterTaskDefinition -> c RegisterTaskDefinition

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RegisterTaskDefinition

toConstr :: RegisterTaskDefinition -> Constr

dataTypeOf :: RegisterTaskDefinition -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RegisterTaskDefinition)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RegisterTaskDefinition)

gmapT :: (forall b. Data b => b -> b) -> RegisterTaskDefinition -> RegisterTaskDefinition

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RegisterTaskDefinition -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RegisterTaskDefinition -> r

gmapQ :: (forall d. Data d => d -> u) -> RegisterTaskDefinition -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> RegisterTaskDefinition -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RegisterTaskDefinition -> m RegisterTaskDefinition

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RegisterTaskDefinition -> m RegisterTaskDefinition

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RegisterTaskDefinition -> m RegisterTaskDefinition

Read RegisterTaskDefinition

Methods

readsPrec :: Int -> ReadS RegisterTaskDefinition

readList :: ReadS [RegisterTaskDefinition]

readPrec :: ReadPrec RegisterTaskDefinition

readListPrec :: ReadPrec [RegisterTaskDefinition]

Show RegisterTaskDefinition

Methods

showsPrec :: Int -> RegisterTaskDefinition -> ShowS

show :: RegisterTaskDefinition -> String

showList :: [RegisterTaskDefinition] -> ShowS

Generic RegisterTaskDefinition

Associated Types

type Rep RegisterTaskDefinition :: * -> *

Methods

from :: RegisterTaskDefinition -> Rep RegisterTaskDefinition x

to :: Rep RegisterTaskDefinition x -> RegisterTaskDefinition

Hashable RegisterTaskDefinition

Methods

hashWithSalt :: Int -> RegisterTaskDefinition -> Int

hash :: RegisterTaskDefinition -> Int

NFData RegisterTaskDefinition

Methods

rnf :: RegisterTaskDefinition -> ()

AWSRequest RegisterTaskDefinition

Associated Types

type Rs RegisterTaskDefinition :: *

Methods

request :: RegisterTaskDefinition -> Request RegisterTaskDefinition

response :: MonadResource m => Logger -> Service -> Proxy * RegisterTaskDefinition -> ClientResponse -> m (Response RegisterTaskDefinition)

ToPath RegisterTaskDefinition

Methods

toPath :: RegisterTaskDefinition -> ByteString

ToHeaders RegisterTaskDefinition

Methods

toHeaders :: RegisterTaskDefinition -> [Header]

ToQuery RegisterTaskDefinition

Methods

toQuery :: RegisterTaskDefinition -> QueryString

ToJSON RegisterTaskDefinition

Methods

toJSON :: RegisterTaskDefinition -> Value

toEncoding :: RegisterTaskDefinition -> Encoding

type Rep RegisterTaskDefinition

type Rep RegisterTaskDefinition = D1 (MetaData "RegisterTaskDefinition" "Network.AWS.ECS.RegisterTaskDefinition" "amazonka-ecs-1.4.4-AOgjorMzZtJAck2Ytj5moD" False) (C1 (MetaCons "RegisterTaskDefinition'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_rtdTaskRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_rtdNetworkMode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe NetworkMode)))) ((:*:) (S1 (MetaSel (Just Symbol "_rtdVolumes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Volume]))) ((:*:) (S1 (MetaSel (Just Symbol "_rtdFamily") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_rtdContainerDefinitions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [ContainerDefinition]))))))

type Rs RegisterTaskDefinition

type Rs RegisterTaskDefinition = RegisterTaskDefinitionResponse

Request Lenses

rtdTaskRoleARN :: Lens' RegisterTaskDefinition (Maybe Text)

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.

rtdNetworkMode :: Lens' RegisterTaskDefinition (Maybe NetworkMode)

The Docker networking mode to use for the containers in the task. The valid values are none, bridge, and host.

The default Docker network mode is bridge. If the network mode is set to none, you cannot specify port mappings in your container definitions, and the task's containers do not have external connectivity. The host network mode offers the highest networking performance for containers because they use the host network stack instead of the virtualized network stack provided by the bridge mode; however, exposed container ports are mapped directly to the corresponding host port, so you cannot take advantage of dynamic host port mappings or run multiple instantiations of the same task on a single container instance if port mappings are used.

For more information, see Network settings in the Docker run reference.

rtdVolumes :: Lens' RegisterTaskDefinition [Volume]

A list of volume definitions in JSON format that containers in your task may use.

rtdFamily :: Lens' RegisterTaskDefinition Text

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.

rtdContainerDefinitions :: Lens' RegisterTaskDefinition [ContainerDefinition]

A list of container definitions in JSON format that describe the different containers that make up your task.

Destructuring the Response

registerTaskDefinitionResponse

Arguments

:: Int

rtdrsResponseStatus

-> RegisterTaskDefinitionResponse

Creates a value of RegisterTaskDefinitionResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rtdrsTaskDefinition
• rtdrsResponseStatus

data RegisterTaskDefinitionResponse

See: registerTaskDefinitionResponse smart constructor.

Instances

Eq RegisterTaskDefinitionResponse

Methods

(==) :: RegisterTaskDefinitionResponse -> RegisterTaskDefinitionResponse -> Bool

(/=) :: RegisterTaskDefinitionResponse -> RegisterTaskDefinitionResponse -> Bool

Data RegisterTaskDefinitionResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RegisterTaskDefinitionResponse -> c RegisterTaskDefinitionResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RegisterTaskDefinitionResponse

toConstr :: RegisterTaskDefinitionResponse -> Constr

dataTypeOf :: RegisterTaskDefinitionResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c RegisterTaskDefinitionResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RegisterTaskDefinitionResponse)

gmapT :: (forall b. Data b => b -> b) -> RegisterTaskDefinitionResponse -> RegisterTaskDefinitionResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RegisterTaskDefinitionResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RegisterTaskDefinitionResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> RegisterTaskDefinitionResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> RegisterTaskDefinitionResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> RegisterTaskDefinitionResponse -> m RegisterTaskDefinitionResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RegisterTaskDefinitionResponse -> m RegisterTaskDefinitionResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RegisterTaskDefinitionResponse -> m RegisterTaskDefinitionResponse

Read RegisterTaskDefinitionResponse

Methods

readsPrec :: Int -> ReadS RegisterTaskDefinitionResponse

readList :: ReadS [RegisterTaskDefinitionResponse]

readPrec :: ReadPrec RegisterTaskDefinitionResponse

readListPrec :: ReadPrec [RegisterTaskDefinitionResponse]

Show RegisterTaskDefinitionResponse

Methods

showsPrec :: Int -> RegisterTaskDefinitionResponse -> ShowS

show :: RegisterTaskDefinitionResponse -> String

showList :: [RegisterTaskDefinitionResponse] -> ShowS

Generic RegisterTaskDefinitionResponse

Associated Types

type Rep RegisterTaskDefinitionResponse :: * -> *

Methods

from :: RegisterTaskDefinitionResponse -> Rep RegisterTaskDefinitionResponse x

to :: Rep RegisterTaskDefinitionResponse x -> RegisterTaskDefinitionResponse

NFData RegisterTaskDefinitionResponse

Methods

rnf :: RegisterTaskDefinitionResponse -> ()

type Rep RegisterTaskDefinitionResponse

type Rep RegisterTaskDefinitionResponse = D1 (MetaData "RegisterTaskDefinitionResponse" "Network.AWS.ECS.RegisterTaskDefinition" "amazonka-ecs-1.4.4-AOgjorMzZtJAck2Ytj5moD" False) (C1 (MetaCons "RegisterTaskDefinitionResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_rtdrsTaskDefinition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe TaskDefinition))) (S1 (MetaSel (Just Symbol "_rtdrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

rtdrsTaskDefinition :: Lens' RegisterTaskDefinitionResponse (Maybe TaskDefinition)

The full description of the registered task definition.

rtdrsResponseStatus :: Lens' RegisterTaskDefinitionResponse Int

The response status code.