Network.AWS.SSM.CreateActivation

Registers your on-premises server or virtual machine with Amazon EC2 so that you can manage these resources using Run Command. An on-premises server or virtual machine that has been registered with EC2 is called a managed instance. For more information about activations, see Setting Up Systems Manager in Hybrid Environments .

Creating a Request

createActivation

Arguments

:: Text

caIAMRole

-> CreateActivation

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

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

• caDefaultInstanceName - The name of the registered, managed instance as it will appear in the Amazon EC2 console or when you use the AWS command line tools to list EC2 resources. Important: Do not enter personally identifiable information in this field.
• caRegistrationLimit - Specify the maximum number of managed instances you want to register. The default value is 1 instance.
• caExpirationDate - The date by which this activation request should expire. The default value is 24 hours.
• caDescription - A user-defined description of the resource that you want to register with Amazon EC2. Important: Do not enter personally identifiable information in this field.
• caIAMRole - The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance.

data CreateActivation

See: createActivation smart constructor.

Instances

Eq CreateActivation

Methods

(==) :: CreateActivation -> CreateActivation -> Bool

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

Data CreateActivation

Methods

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

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

toConstr :: CreateActivation -> Constr

dataTypeOf :: CreateActivation -> DataType

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

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

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

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

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

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

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

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

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

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

Read CreateActivation

Methods

readsPrec :: Int -> ReadS CreateActivation

readList :: ReadS [CreateActivation]

readPrec :: ReadPrec CreateActivation

readListPrec :: ReadPrec [CreateActivation]

Show CreateActivation

Methods

showsPrec :: Int -> CreateActivation -> ShowS

show :: CreateActivation -> String

showList :: [CreateActivation] -> ShowS

Generic CreateActivation

Associated Types

type Rep CreateActivation :: * -> *

Methods

from :: CreateActivation -> Rep CreateActivation x

to :: Rep CreateActivation x -> CreateActivation

Hashable CreateActivation

Methods

hashWithSalt :: Int -> CreateActivation -> Int

hash :: CreateActivation -> Int

ToJSON CreateActivation

Methods

toJSON :: CreateActivation -> Value

toEncoding :: CreateActivation -> Encoding

toJSONList :: [CreateActivation] -> Value

toEncodingList :: [CreateActivation] -> Encoding

NFData CreateActivation

Methods

rnf :: CreateActivation -> ()

AWSRequest CreateActivation

Associated Types

type Rs CreateActivation :: *

Methods

request :: CreateActivation -> Request CreateActivation

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * CreateActivation -> ClientResponse -> m (Response CreateActivation)

ToHeaders CreateActivation

Methods

toHeaders :: CreateActivation -> [Header]

ToPath CreateActivation

Methods

toPath :: CreateActivation -> ByteString

ToQuery CreateActivation

Methods

toQuery :: CreateActivation -> QueryString

type Rep CreateActivation

type Rep CreateActivation = D1 * (MetaData "CreateActivation" "Network.AWS.SSM.CreateActivation" "amazonka-ssm-1.6.0-FkXaKF9jjpY64HF15tLQlO" False) (C1 * (MetaCons "CreateActivation'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_caDefaultInstanceName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_caRegistrationLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_caExpirationDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe POSIX))) ((:*:) * (S1 * (MetaSel (Just Symbol "_caDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_caIAMRole") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))

type Rs CreateActivation

type Rs CreateActivation = CreateActivationResponse

Request Lenses

caDefaultInstanceName :: Lens' CreateActivation (Maybe Text)

The name of the registered, managed instance as it will appear in the Amazon EC2 console or when you use the AWS command line tools to list EC2 resources. Important: Do not enter personally identifiable information in this field.

caRegistrationLimit :: Lens' CreateActivation (Maybe Natural)

Specify the maximum number of managed instances you want to register. The default value is 1 instance.

caExpirationDate :: Lens' CreateActivation (Maybe UTCTime)

The date by which this activation request should expire. The default value is 24 hours.

caDescription :: Lens' CreateActivation (Maybe Text)

A user-defined description of the resource that you want to register with Amazon EC2. Important: Do not enter personally identifiable information in this field.

caIAMRole :: Lens' CreateActivation Text

The Amazon Identity and Access Management (IAM) role that you want to assign to the managed instance.

Destructuring the Response

createActivationResponse

Arguments

:: Int

carsResponseStatus

-> CreateActivationResponse

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

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

• carsActivationId - The ID number generated by the system when it processed the activation. The activation ID functions like a user name.
• carsActivationCode - The code the system generates when it processes the activation. The activation code functions like a password to validate the activation ID.
• carsResponseStatus - -- | The response status code.

data CreateActivationResponse

See: createActivationResponse smart constructor.

Instances

Eq CreateActivationResponse

Methods

(==) :: CreateActivationResponse -> CreateActivationResponse -> Bool

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

Data CreateActivationResponse

Methods

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

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

toConstr :: CreateActivationResponse -> Constr

dataTypeOf :: CreateActivationResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read CreateActivationResponse

Methods

readsPrec :: Int -> ReadS CreateActivationResponse

readList :: ReadS [CreateActivationResponse]

readPrec :: ReadPrec CreateActivationResponse

readListPrec :: ReadPrec [CreateActivationResponse]

Show CreateActivationResponse

Methods

showsPrec :: Int -> CreateActivationResponse -> ShowS

show :: CreateActivationResponse -> String

showList :: [CreateActivationResponse] -> ShowS

Generic CreateActivationResponse

Associated Types

type Rep CreateActivationResponse :: * -> *

Methods

from :: CreateActivationResponse -> Rep CreateActivationResponse x

to :: Rep CreateActivationResponse x -> CreateActivationResponse

NFData CreateActivationResponse

Methods

rnf :: CreateActivationResponse -> ()

type Rep CreateActivationResponse

type Rep CreateActivationResponse = D1 * (MetaData "CreateActivationResponse" "Network.AWS.SSM.CreateActivation" "amazonka-ssm-1.6.0-FkXaKF9jjpY64HF15tLQlO" False) (C1 * (MetaCons "CreateActivationResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_carsActivationId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_carsActivationCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_carsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

carsActivationId :: Lens' CreateActivationResponse (Maybe Text)

The ID number generated by the system when it processed the activation. The activation ID functions like a user name.

carsActivationCode :: Lens' CreateActivationResponse (Maybe Text)

The code the system generates when it processes the activation. The activation code functions like a password to validate the activation ID.

carsResponseStatus :: Lens' CreateActivationResponse Int

• - | The response status code.