amazonka-oam-2.0: Amazon CloudWatch Observability Access Manager SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.OAM.CreateLink

Description

Creates a link between a source account and a sink that you have created in a monitoring account.

Before you create a link, you must create a sink in the monitoring account and create a sink policy in that account. The sink policy must permit the source account to link to it. You can grant permission to source accounts by granting permission to an entire organization or to individual accounts.

For more information, see CreateSink and PutSinkPolicy.

Each monitoring account can be linked to as many as 100,000 source accounts.

Each source account can be linked to as many as five monitoring accounts.

Synopsis

Creating a Request

data CreateLink Source #

See: newCreateLink smart constructor.

Constructors

CreateLink' 

Fields

  • tags :: Maybe (HashMap Text Text)

    Assigns one or more tags (key-value pairs) to the link.

    Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

    For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.

  • labelTemplate :: Text

    Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.

    You can use a custom label or use the following variables:

    • $AccountName is the name of the account
    • $AccountEmail is the globally unique email address of the account
    • $AccountEmailNoDomain is the email address of the account without the domain name
  • resourceTypes :: NonEmpty ResourceType

    An array of strings that define which types of data that the source account shares with the monitoring account.

  • sinkIdentifier :: Text

    The ARN of the sink to use to create this link. You can use ListSinks to find the ARNs of sinks.

    For more information about sinks, see CreateSink.

Instances

newCreateLink Source #

Arguments

:: Text

CreateLink

-> NonEmpty ResourceType

CreateLink

-> Text

$sel:sinkIdentifier:CreateLink'

-> CreateLink 

Create a value of CreateLink 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:

CreateLink, createLink_tags - Assigns one or more tags (key-value pairs) to the link.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.

CreateLink, createLink_labelTemplate - Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.

You can use a custom label or use the following variables:

  • $AccountName is the name of the account
  • $AccountEmail is the globally unique email address of the account
  • $AccountEmailNoDomain is the email address of the account without the domain name

CreateLink, createLink_resourceTypes - An array of strings that define which types of data that the source account shares with the monitoring account.

$sel:sinkIdentifier:CreateLink', createLink_sinkIdentifier - The ARN of the sink to use to create this link. You can use ListSinks to find the ARNs of sinks.

For more information about sinks, see CreateSink.

Request Lenses

createLink_tags :: Lens' CreateLink (Maybe (HashMap Text Text)) Source #

Assigns one or more tags (key-value pairs) to the link.

Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

For more information about using tags to control access, see Controlling access to Amazon Web Services resources using tags.

createLink_labelTemplate :: Lens' CreateLink Text Source #

Specify a friendly human-readable name to use to identify this source account when you are viewing data from it in the monitoring account.

You can use a custom label or use the following variables:

  • $AccountName is the name of the account
  • $AccountEmail is the globally unique email address of the account
  • $AccountEmailNoDomain is the email address of the account without the domain name

createLink_resourceTypes :: Lens' CreateLink (NonEmpty ResourceType) Source #

An array of strings that define which types of data that the source account shares with the monitoring account.

createLink_sinkIdentifier :: Lens' CreateLink Text Source #

The ARN of the sink to use to create this link. You can use ListSinks to find the ARNs of sinks.

For more information about sinks, see CreateSink.

Destructuring the Response

data CreateLinkResponse Source #

See: newCreateLinkResponse smart constructor.

Constructors

CreateLinkResponse' 

Fields

  • arn :: Maybe Text

    The ARN of the link that is newly created.

  • id :: Maybe Text

    The random ID string that Amazon Web Services generated as part of the link ARN.

  • label :: Maybe Text

    The label that you assigned to this link. If the labelTemplate includes variables, this field displays the variables resolved to their actual values.

  • labelTemplate :: Maybe Text

    The exact label template that you specified, with the variables not resolved.

  • resourceTypes :: Maybe [Text]

    The resource types supported by this link.

  • sinkArn :: Maybe Text

    The ARN of the sink that is used for this link.

  • tags :: Maybe (HashMap Text Text)

    The tags assigned to the link.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic CreateLinkResponse Source # 
Instance details

Defined in Amazonka.OAM.CreateLink

Associated Types

type Rep CreateLinkResponse :: Type -> Type #

Methods

from :: CreateLinkResponse -> Rep CreateLinkResponse x #

to :: Rep CreateLinkResponse x -> CreateLinkResponse #

Read CreateLinkResponse Source # 
Instance details

Defined in Amazonka.OAM.CreateLink

Methods

readsPrec :: Int -> ReadS CreateLinkResponse #

readList :: ReadS [CreateLinkResponse] #

readPrec :: ReadPrec CreateLinkResponse #

readListPrec :: ReadPrec [CreateLinkResponse] #

Show CreateLinkResponse Source # 
Instance details

Defined in Amazonka.OAM.CreateLink

Methods

showsPrec :: Int -> CreateLinkResponse -> ShowS #

show :: CreateLinkResponse -> String #

showList :: [CreateLinkResponse] -> ShowS #

NFData CreateLinkResponse Source # 
Instance details

Defined in Amazonka.OAM.CreateLink

Methods

rnf :: CreateLinkResponse -> () #

Eq CreateLinkResponse Source # 
Instance details

Defined in Amazonka.OAM.CreateLink

Methods

(==) :: CreateLinkResponse -> CreateLinkResponse -> Bool #

(/=) :: CreateLinkResponse -> CreateLinkResponse -> Bool #

type Rep CreateLinkResponse Source # 
Instance details

Defined in Amazonka.OAM.CreateLink

type Rep CreateLinkResponse = D1 ('MetaData "CreateLinkResponse" "Amazonka.OAM.CreateLink" "amazonka-oam-2.0-2r3dTellrOe218sRY2Qi5h" 'False) (C1 ('MetaCons "CreateLinkResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "label") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "labelTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "resourceTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "sinkArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreateLinkResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateLinkResponse'

-> CreateLinkResponse 

Create a value of CreateLinkResponse 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:

CreateLinkResponse, createLinkResponse_arn - The ARN of the link that is newly created.

CreateLinkResponse, createLinkResponse_id - The random ID string that Amazon Web Services generated as part of the link ARN.

CreateLinkResponse, createLinkResponse_label - The label that you assigned to this link. If the labelTemplate includes variables, this field displays the variables resolved to their actual values.

CreateLink, createLinkResponse_labelTemplate - The exact label template that you specified, with the variables not resolved.

CreateLink, createLinkResponse_resourceTypes - The resource types supported by this link.

CreateLinkResponse, createLinkResponse_sinkArn - The ARN of the sink that is used for this link.

CreateLink, createLinkResponse_tags - The tags assigned to the link.

$sel:httpStatus:CreateLinkResponse', createLinkResponse_httpStatus - The response's http status code.

Response Lenses

createLinkResponse_arn :: Lens' CreateLinkResponse (Maybe Text) Source #

The ARN of the link that is newly created.

createLinkResponse_id :: Lens' CreateLinkResponse (Maybe Text) Source #

The random ID string that Amazon Web Services generated as part of the link ARN.

createLinkResponse_label :: Lens' CreateLinkResponse (Maybe Text) Source #

The label that you assigned to this link. If the labelTemplate includes variables, this field displays the variables resolved to their actual values.

createLinkResponse_labelTemplate :: Lens' CreateLinkResponse (Maybe Text) Source #

The exact label template that you specified, with the variables not resolved.

createLinkResponse_resourceTypes :: Lens' CreateLinkResponse (Maybe [Text]) Source #

The resource types supported by this link.

createLinkResponse_sinkArn :: Lens' CreateLinkResponse (Maybe Text) Source #

The ARN of the sink that is used for this link.

createLinkResponse_tags :: Lens' CreateLinkResponse (Maybe (HashMap Text Text)) Source #

The tags assigned to the link.

createLinkResponse_httpStatus :: Lens' CreateLinkResponse Int Source #

The response's http status code.