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.OAM.CreateSink

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Use this to create a sink in the current account, so that it can be used as a monitoring account in CloudWatch cross-account observability. A sink is a resource that represents an attachment point in a monitoring account. Source accounts can link to the sink to send observability data.

After you create a sink, you must create a sink policy that allows source accounts to attach to it. For more information, see PutSinkPolicy.

Each account can contain one sink. If you delete a sink, you can then create a new one in that account.

Synopsis

data CreateSink = CreateSink' {
- tags :: Maybe (HashMap Text Text)
- name :: Text
}
newCreateSink :: Text -> CreateSink
createSink_tags :: Lens' CreateSink (Maybe (HashMap Text Text))
createSink_name :: Lens' CreateSink Text
data CreateSinkResponse = CreateSinkResponse' {
- arn :: Maybe Text
- id :: Maybe Text
- name :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
}
newCreateSinkResponse :: Int -> CreateSinkResponse
createSinkResponse_arn :: Lens' CreateSinkResponse (Maybe Text)
createSinkResponse_id :: Lens' CreateSinkResponse (Maybe Text)
createSinkResponse_name :: Lens' CreateSinkResponse (Maybe Text)
createSinkResponse_tags :: Lens' CreateSinkResponse (Maybe (HashMap Text Text))
createSinkResponse_httpStatus :: Lens' CreateSinkResponse Int

Creating a Request

data CreateSink Source #

See: newCreateSink smart constructor.

Constructors

CreateSink'

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.
name :: Text
A name for the sink.

Instances

Instances details

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

newCreateSink Source #

Arguments

:: Text	`CreateSink`
-> CreateSink

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

CreateSink, createSink_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.

CreateSink, createSink_name - A name for the sink.

Request Lenses

createSink_tags :: Lens' CreateSink (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.

createSink_name :: Lens' CreateSink Text Source #

A name for the sink.

Destructuring the Response

data CreateSinkResponse Source #

See: newCreateSinkResponse smart constructor.

Constructors

CreateSinkResponse'
Fields arn :: Maybe Text The ARN of the sink that is newly created. id :: Maybe Text The random ID string that Amazon Web Services generated as part of the sink ARN. name :: Maybe Text The name of the sink. tags :: Maybe (HashMap Text Text) The tags assigned to the sink. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateSinkResponse Source #
Instance details Defined in Amazonka.OAM.CreateSink Associated Types type Rep CreateSinkResponse :: Type -> Type # Methods from :: CreateSinkResponse -> Rep CreateSinkResponse x # to :: Rep CreateSinkResponse x -> CreateSinkResponse #
Read CreateSinkResponse Source #
Instance details Defined in Amazonka.OAM.CreateSink Methods readsPrec :: Int -> ReadS CreateSinkResponse # readList :: ReadS [CreateSinkResponse] # readPrec :: ReadPrec CreateSinkResponse # readListPrec :: ReadPrec [CreateSinkResponse] #
Show CreateSinkResponse Source #
Instance details Defined in Amazonka.OAM.CreateSink Methods showsPrec :: Int -> CreateSinkResponse -> ShowS # show :: CreateSinkResponse -> String # showList :: [CreateSinkResponse] -> ShowS #
NFData CreateSinkResponse Source #
Instance details Defined in Amazonka.OAM.CreateSink Methods rnf :: CreateSinkResponse -> () #
Eq CreateSinkResponse Source #
Instance details Defined in Amazonka.OAM.CreateSink Methods (==) :: CreateSinkResponse -> CreateSinkResponse -> Bool # (/=) :: CreateSinkResponse -> CreateSinkResponse -> Bool #
type Rep CreateSinkResponse Source #
Instance details Defined in Amazonka.OAM.CreateSink type Rep CreateSinkResponse = D1 ('MetaData "CreateSinkResponse" "Amazonka.OAM.CreateSink" "amazonka-oam-2.0-2r3dTellrOe218sRY2Qi5h" 'False) (C1 ('MetaCons "CreateSinkResponse'" '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 "name") '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)))))

newCreateSinkResponse Source #

Arguments

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

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

CreateSinkResponse, createSinkResponse_arn - The ARN of the sink that is newly created.

CreateSinkResponse, createSinkResponse_id - The random ID string that Amazon Web Services generated as part of the sink ARN.

CreateSink, createSinkResponse_name - The name of the sink.

CreateSink, createSinkResponse_tags - The tags assigned to the sink.

$sel:httpStatus:CreateSinkResponse', createSinkResponse_httpStatus - The response's http status code.

Response Lenses

createSinkResponse_arn :: Lens' CreateSinkResponse (Maybe Text) Source #

The ARN of the sink that is newly created.

createSinkResponse_id :: Lens' CreateSinkResponse (Maybe Text) Source #

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

createSinkResponse_name :: Lens' CreateSinkResponse (Maybe Text) Source #

The name of the sink.

createSinkResponse_tags :: Lens' CreateSinkResponse (Maybe (HashMap Text Text)) Source #

The tags assigned to the sink.

createSinkResponse_httpStatus :: Lens' CreateSinkResponse Int Source #

The response's http status code.