Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SSM.CreateActivation

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Generates an activation code and activation ID you can use to register your on-premises servers, edge devices, or virtual machine (VM) with Amazon Web Services Systems Manager. Registering these machines with Systems Manager makes it possible to manage them using Systems Manager capabilities. You use the activation code and ID when installing SSM Agent on machines in your hybrid environment. For more information about requirements for managing on-premises machines using Systems Manager, see Setting up Amazon Web Services Systems Manager for hybrid environments in the Amazon Web Services Systems Manager User Guide.

Amazon Elastic Compute Cloud (Amazon EC2) instances, edge devices, and on-premises servers and VMs that are configured for Systems Manager are all called managed nodes.

Synopsis

data CreateActivation = CreateActivation' {
- defaultInstanceName :: Maybe Text
- description :: Maybe Text
- expirationDate :: Maybe POSIX
- registrationLimit :: Maybe Natural
- registrationMetadata :: Maybe [RegistrationMetadataItem]
- tags :: Maybe [Tag]
- iamRole :: Text
}
newCreateActivation :: Text -> CreateActivation
createActivation_defaultInstanceName :: Lens' CreateActivation (Maybe Text)
createActivation_description :: Lens' CreateActivation (Maybe Text)
createActivation_expirationDate :: Lens' CreateActivation (Maybe UTCTime)
createActivation_registrationLimit :: Lens' CreateActivation (Maybe Natural)
createActivation_registrationMetadata :: Lens' CreateActivation (Maybe [RegistrationMetadataItem])
createActivation_tags :: Lens' CreateActivation (Maybe [Tag])
createActivation_iamRole :: Lens' CreateActivation Text
data CreateActivationResponse = CreateActivationResponse' {
- activationCode :: Maybe Text
- activationId :: Maybe Text
- httpStatus :: Int
}
newCreateActivationResponse :: Int -> CreateActivationResponse
createActivationResponse_activationCode :: Lens' CreateActivationResponse (Maybe Text)
createActivationResponse_activationId :: Lens' CreateActivationResponse (Maybe Text)
createActivationResponse_httpStatus :: Lens' CreateActivationResponse Int

Creating a Request

data CreateActivation Source #

See: newCreateActivation smart constructor.

Constructors

CreateActivation'

Fields

defaultInstanceName :: Maybe Text
The name of the registered, managed node as it will appear in the Amazon Web Services Systems Manager console or when you use the Amazon Web Services command line tools to list Systems Manager resources.
Don't enter personally identifiable information in this field.
description :: Maybe Text
A user-defined description of the resource that you want to register with Systems Manager.
Don't enter personally identifiable information in this field.
expirationDate :: Maybe POSIX
The date by which this activation request should expire, in timestamp format, such as "2021-07-07T00:00:00". You can specify a date up to 30 days in advance. If you don't provide an expiration date, the activation code expires in 24 hours.
registrationLimit :: Maybe Natural
Specify the maximum number of managed nodes you want to register. The default value is 1.
registrationMetadata :: Maybe [RegistrationMetadataItem]
Reserved for internal use.
tags :: Maybe [Tag]
Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key-value pairs:
- ```
Key=OS,Value=Windows
```
- ```
Key=Environment,Value=Production
```
When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs.
You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers, edge devices, and VMs after they connect to Systems Manager for the first time and are assigned a managed node ID. This means they are listed in the Amazon Web Services Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed nodes, see AddTagsToResource. For information about how to remove tags from your managed nodes, see RemoveTagsFromResource.
iamRole :: Text
The name of the Identity and Access Management (IAM) role that you want to assign to the managed node. This IAM role must provide AssumeRole permissions for the Amazon Web Services Systems Manager service principal ssm.amazonaws.com. For more information, see Create an IAM service role for a hybrid environment in the Amazon Web Services Systems Manager User Guide.
You can't specify an IAM service-linked role for this parameter. You must create a unique role.

Instances

Instances details

ToJSON CreateActivation Source #
Instance details Defined in Amazonka.SSM.CreateActivation Methods toJSON :: CreateActivation -> Value # toEncoding :: CreateActivation -> Encoding # toJSONList :: [CreateActivation] -> Value # toEncodingList :: [CreateActivation] -> Encoding #
ToHeaders CreateActivation Source #
Instance details Defined in Amazonka.SSM.CreateActivation Methods toHeaders :: CreateActivation -> [Header] #
ToPath CreateActivation Source #
Instance details Defined in Amazonka.SSM.CreateActivation Methods toPath :: CreateActivation -> ByteString #
ToQuery CreateActivation Source #
Instance details Defined in Amazonka.SSM.CreateActivation Methods toQuery :: CreateActivation -> QueryString #
AWSRequest CreateActivation Source #
Instance details Defined in Amazonka.SSM.CreateActivation Associated Types type AWSResponse CreateActivation # Methods request :: (Service -> Service) -> CreateActivation -> Request CreateActivation # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateActivation -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateActivation))) #
Generic CreateActivation Source #
Instance details Defined in Amazonka.SSM.CreateActivation Associated Types type Rep CreateActivation :: Type -> Type # Methods from :: CreateActivation -> Rep CreateActivation x # to :: Rep CreateActivation x -> CreateActivation #
Read CreateActivation Source #
Instance details Defined in Amazonka.SSM.CreateActivation Methods readsPrec :: Int -> ReadS CreateActivation # readList :: ReadS [CreateActivation] # readPrec :: ReadPrec CreateActivation # readListPrec :: ReadPrec [CreateActivation] #
Show CreateActivation Source #
Instance details Defined in Amazonka.SSM.CreateActivation Methods showsPrec :: Int -> CreateActivation -> ShowS # show :: CreateActivation -> String # showList :: [CreateActivation] -> ShowS #
NFData CreateActivation Source #
Instance details Defined in Amazonka.SSM.CreateActivation Methods rnf :: CreateActivation -> () #
Eq CreateActivation Source #
Instance details Defined in Amazonka.SSM.CreateActivation Methods (==) :: CreateActivation -> CreateActivation -> Bool # (/=) :: CreateActivation -> CreateActivation -> Bool #
Hashable CreateActivation Source #
Instance details Defined in Amazonka.SSM.CreateActivation Methods hashWithSalt :: Int -> CreateActivation -> Int # hash :: CreateActivation -> Int #
type AWSResponse CreateActivation Source #
Instance details Defined in Amazonka.SSM.CreateActivation type AWSResponse CreateActivation = CreateActivationResponse
type Rep CreateActivation Source #
Instance details Defined in Amazonka.SSM.CreateActivation type Rep CreateActivation = D1 ('MetaData "CreateActivation" "Amazonka.SSM.CreateActivation" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "CreateActivation'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "defaultInstanceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "expirationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "registrationLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "registrationMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RegistrationMetadataItem]))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "iamRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateActivation Source #

Arguments

:: Text	`CreateActivation`
-> CreateActivation

Create a value of CreateActivation with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateActivation, createActivation_defaultInstanceName - The name of the registered, managed node as it will appear in the Amazon Web Services Systems Manager console or when you use the Amazon Web Services command line tools to list Systems Manager resources.

Don't enter personally identifiable information in this field.

CreateActivation, createActivation_description - A user-defined description of the resource that you want to register with Systems Manager.

Don't enter personally identifiable information in this field.

CreateActivation, createActivation_expirationDate - The date by which this activation request should expire, in timestamp format, such as "2021-07-07T00:00:00". You can specify a date up to 30 days in advance. If you don't provide an expiration date, the activation code expires in 24 hours.

CreateActivation, createActivation_registrationLimit - Specify the maximum number of managed nodes you want to register. The default value is 1.

$sel:registrationMetadata:CreateActivation', createActivation_registrationMetadata - Reserved for internal use.

CreateActivation, createActivation_tags - Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key-value pairs:

```
Key=OS,Value=Windows
```
```
Key=Environment,Value=Production
```

When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs.

You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers, edge devices, and VMs after they connect to Systems Manager for the first time and are assigned a managed node ID. This means they are listed in the Amazon Web Services Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed nodes, see AddTagsToResource. For information about how to remove tags from your managed nodes, see RemoveTagsFromResource.

CreateActivation, createActivation_iamRole - The name of the Identity and Access Management (IAM) role that you want to assign to the managed node. This IAM role must provide AssumeRole permissions for the Amazon Web Services Systems Manager service principal ssm.amazonaws.com. For more information, see Create an IAM service role for a hybrid environment in the Amazon Web Services Systems Manager User Guide.

You can't specify an IAM service-linked role for this parameter. You must create a unique role.

Request Lenses

createActivation_defaultInstanceName :: Lens' CreateActivation (Maybe Text) Source #

The name of the registered, managed node as it will appear in the Amazon Web Services Systems Manager console or when you use the Amazon Web Services command line tools to list Systems Manager resources.

Don't enter personally identifiable information in this field.

createActivation_description :: Lens' CreateActivation (Maybe Text) Source #

A user-defined description of the resource that you want to register with Systems Manager.

Don't enter personally identifiable information in this field.

createActivation_expirationDate :: Lens' CreateActivation (Maybe UTCTime) Source #

The date by which this activation request should expire, in timestamp format, such as "2021-07-07T00:00:00". You can specify a date up to 30 days in advance. If you don't provide an expiration date, the activation code expires in 24 hours.

createActivation_registrationLimit :: Lens' CreateActivation (Maybe Natural) Source #

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

createActivation_registrationMetadata :: Lens' CreateActivation (Maybe [RegistrationMetadataItem]) Source #

Reserved for internal use.

createActivation_tags :: Lens' CreateActivation (Maybe [Tag]) Source #

Optional metadata that you assign to a resource. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an activation to identify which servers or virtual machines (VMs) in your on-premises environment you intend to activate. In this case, you could specify the following key-value pairs:

```
Key=OS,Value=Windows
```
```
Key=Environment,Value=Production
```

When you install SSM Agent on your on-premises servers and VMs, you specify an activation ID and code. When you specify the activation ID and code, tags assigned to the activation are automatically applied to the on-premises servers or VMs.

You can't add tags to or delete tags from an existing activation. You can tag your on-premises servers, edge devices, and VMs after they connect to Systems Manager for the first time and are assigned a managed node ID. This means they are listed in the Amazon Web Services Systems Manager console with an ID that is prefixed with "mi-". For information about how to add tags to your managed nodes, see AddTagsToResource. For information about how to remove tags from your managed nodes, see RemoveTagsFromResource.

createActivation_iamRole :: Lens' CreateActivation Text Source #

The name of the Identity and Access Management (IAM) role that you want to assign to the managed node. This IAM role must provide AssumeRole permissions for the Amazon Web Services Systems Manager service principal ssm.amazonaws.com. For more information, see Create an IAM service role for a hybrid environment in the Amazon Web Services Systems Manager User Guide.

You can't specify an IAM service-linked role for this parameter. You must create a unique role.

Destructuring the Response

data CreateActivationResponse Source #

See: newCreateActivationResponse smart constructor.

Constructors

CreateActivationResponse'
Fields activationCode :: Maybe Text The code the system generates when it processes the activation. The activation code functions like a password to validate the activation ID. activationId :: Maybe Text The ID number generated by the system when it processed the activation. The activation ID functions like a user name. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateActivationResponse Source #
Instance details Defined in Amazonka.SSM.CreateActivation Associated Types type Rep CreateActivationResponse :: Type -> Type # Methods from :: CreateActivationResponse -> Rep CreateActivationResponse x # to :: Rep CreateActivationResponse x -> CreateActivationResponse #
Read CreateActivationResponse Source #
Instance details Defined in Amazonka.SSM.CreateActivation Methods readsPrec :: Int -> ReadS CreateActivationResponse # readList :: ReadS [CreateActivationResponse] # readPrec :: ReadPrec CreateActivationResponse # readListPrec :: ReadPrec [CreateActivationResponse] #
Show CreateActivationResponse Source #
Instance details Defined in Amazonka.SSM.CreateActivation Methods showsPrec :: Int -> CreateActivationResponse -> ShowS # show :: CreateActivationResponse -> String # showList :: [CreateActivationResponse] -> ShowS #
NFData CreateActivationResponse Source #
Instance details Defined in Amazonka.SSM.CreateActivation Methods rnf :: CreateActivationResponse -> () #
Eq CreateActivationResponse Source #
Instance details Defined in Amazonka.SSM.CreateActivation Methods (==) :: CreateActivationResponse -> CreateActivationResponse -> Bool # (/=) :: CreateActivationResponse -> CreateActivationResponse -> Bool #
type Rep CreateActivationResponse Source #
Instance details Defined in Amazonka.SSM.CreateActivation type Rep CreateActivationResponse = D1 ('MetaData "CreateActivationResponse" "Amazonka.SSM.CreateActivation" "amazonka-ssm-2.0-Ak65QSGRhJDC5x7UvsCpi8" 'False) (C1 ('MetaCons "CreateActivationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "activationCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "activationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateActivationResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateActivationResponse'`
-> CreateActivationResponse

Create a value of CreateActivationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:activationCode:CreateActivationResponse', createActivationResponse_activationCode - The code the system generates when it processes the activation. The activation code functions like a password to validate the activation ID.

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

$sel:httpStatus:CreateActivationResponse', createActivationResponse_httpStatus - The response's http status code.

Response Lenses

createActivationResponse_activationCode :: Lens' CreateActivationResponse (Maybe Text) Source #

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

createActivationResponse_activationId :: Lens' CreateActivationResponse (Maybe Text) Source #

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

createActivationResponse_httpStatus :: Lens' CreateActivationResponse Int Source #

The response's http status code.