Amazonka.CloudWatchLogs.PutDestination

Creates or updates a destination. This operation is used only to create destinations for cross-account subscriptions.

A destination encapsulates a physical resource (such as an Amazon Kinesis stream). With a destination, you can subscribe to a real-time stream of log events for a different account, ingested using PutLogEvents.

Through an access policy, a destination controls what is written to it. By default, PutDestination does not set any access policy with the destination, which means a cross-account user cannot call PutSubscriptionFilter against this destination. To enable this, the destination owner must call PutDestinationPolicy after PutDestination.

To perform a PutDestination operation, you must also have the iam:PassRole permission.

Creating a Request

data PutDestination

See: newPutDestination smart constructor.

Constructors

PutDestination'

Fields

• tags :: Maybe (HashMap Text Text)

  An optional list of key-value pairs to associate with the resource.

  For more information about tagging, see Tagging Amazon Web Services resources

• destinationName :: Text

  A name for the destination.

• targetArn :: Text

  The ARN of an Amazon Kinesis stream to which to deliver matching log events.

• roleArn :: Text

  The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon Kinesis PutRecord operation on the destination stream.

Instances

ToJSON PutDestination

Defined in Amazonka.CloudWatchLogs.PutDestination

Methods

toJSON :: PutDestination -> Value

toEncoding :: PutDestination -> Encoding

toJSONList :: [PutDestination] -> Value

toEncodingList :: [PutDestination] -> Encoding

ToHeaders PutDestination

Defined in Amazonka.CloudWatchLogs.PutDestination

Methods

toHeaders :: PutDestination -> [Header]

ToPath PutDestination

Defined in Amazonka.CloudWatchLogs.PutDestination

Methods

toPath :: PutDestination -> ByteString

ToQuery PutDestination

Defined in Amazonka.CloudWatchLogs.PutDestination

Methods

toQuery :: PutDestination -> QueryString

AWSRequest PutDestination

Defined in Amazonka.CloudWatchLogs.PutDestination

Associated Types

type AWSResponse PutDestination

Methods

request :: (Service -> Service) -> PutDestination -> Request PutDestination

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutDestination -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutDestination)))

Generic PutDestination

Defined in Amazonka.CloudWatchLogs.PutDestination

Associated Types

type Rep PutDestination :: Type -> Type

Methods

from :: PutDestination -> Rep PutDestination x

to :: Rep PutDestination x -> PutDestination

Read PutDestination

Defined in Amazonka.CloudWatchLogs.PutDestination

Methods

readsPrec :: Int -> ReadS PutDestination

readList :: ReadS [PutDestination]

readPrec :: ReadPrec PutDestination

readListPrec :: ReadPrec [PutDestination]

Show PutDestination

Defined in Amazonka.CloudWatchLogs.PutDestination

Methods

showsPrec :: Int -> PutDestination -> ShowS

show :: PutDestination -> String

showList :: [PutDestination] -> ShowS

NFData PutDestination

Defined in Amazonka.CloudWatchLogs.PutDestination

Methods

rnf :: PutDestination -> ()

Eq PutDestination

Defined in Amazonka.CloudWatchLogs.PutDestination

Methods

(==) :: PutDestination -> PutDestination -> Bool

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

Hashable PutDestination

Defined in Amazonka.CloudWatchLogs.PutDestination

Methods

hashWithSalt :: Int -> PutDestination -> Int

hash :: PutDestination -> Int

type AWSResponse PutDestination

Defined in Amazonka.CloudWatchLogs.PutDestination

type AWSResponse PutDestination = PutDestinationResponse

type Rep PutDestination

Defined in Amazonka.CloudWatchLogs.PutDestination

type Rep PutDestination = D1 ('MetaData "PutDestination" "Amazonka.CloudWatchLogs.PutDestination" "amazonka-cloudwatch-logs-2.0-6gvDalNFsfE8djZ4aTfA4V" 'False) (C1 ('MetaCons "PutDestination'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "destinationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "targetArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newPutDestination

Arguments

:: Text

PutDestination

-> Text

PutDestination

-> Text

PutDestination

-> PutDestination

Create a value of PutDestination 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:tags:PutDestination', putDestination_tags - An optional list of key-value pairs to associate with the resource.

For more information about tagging, see Tagging Amazon Web Services resources

PutDestination, putDestination_destinationName - A name for the destination.

PutDestination, putDestination_targetArn - The ARN of an Amazon Kinesis stream to which to deliver matching log events.

PutDestination, putDestination_roleArn - The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon Kinesis PutRecord operation on the destination stream.

Request Lenses

putDestination_tags :: Lens' PutDestination (Maybe (HashMap Text Text))

An optional list of key-value pairs to associate with the resource.

For more information about tagging, see Tagging Amazon Web Services resources

putDestination_destinationName :: Lens' PutDestination Text

A name for the destination.

putDestination_targetArn :: Lens' PutDestination Text

The ARN of an Amazon Kinesis stream to which to deliver matching log events.

putDestination_roleArn :: Lens' PutDestination Text

The ARN of an IAM role that grants CloudWatch Logs permissions to call the Amazon Kinesis PutRecord operation on the destination stream.

Destructuring the Response

data PutDestinationResponse

See: newPutDestinationResponse smart constructor.

Constructors

PutDestinationResponse'

Fields

• destination :: Maybe Destination

  The destination.

• httpStatus :: Int

  The response's http status code.

Instances

Generic PutDestinationResponse

Defined in Amazonka.CloudWatchLogs.PutDestination

Associated Types

type Rep PutDestinationResponse :: Type -> Type

Methods

from :: PutDestinationResponse -> Rep PutDestinationResponse x

to :: Rep PutDestinationResponse x -> PutDestinationResponse

Read PutDestinationResponse

Defined in Amazonka.CloudWatchLogs.PutDestination

Methods

readsPrec :: Int -> ReadS PutDestinationResponse

readList :: ReadS [PutDestinationResponse]

readPrec :: ReadPrec PutDestinationResponse

readListPrec :: ReadPrec [PutDestinationResponse]

Show PutDestinationResponse

Defined in Amazonka.CloudWatchLogs.PutDestination

Methods

showsPrec :: Int -> PutDestinationResponse -> ShowS

show :: PutDestinationResponse -> String

showList :: [PutDestinationResponse] -> ShowS

NFData PutDestinationResponse

Defined in Amazonka.CloudWatchLogs.PutDestination

Methods

rnf :: PutDestinationResponse -> ()

Eq PutDestinationResponse

Defined in Amazonka.CloudWatchLogs.PutDestination

Methods

(==) :: PutDestinationResponse -> PutDestinationResponse -> Bool

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

type Rep PutDestinationResponse

Defined in Amazonka.CloudWatchLogs.PutDestination

type Rep PutDestinationResponse = D1 ('MetaData "PutDestinationResponse" "Amazonka.CloudWatchLogs.PutDestination" "amazonka-cloudwatch-logs-2.0-6gvDalNFsfE8djZ4aTfA4V" 'False) (C1 ('MetaCons "PutDestinationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "destination") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Destination)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPutDestinationResponse

Arguments

:: Int

$sel:httpStatus:PutDestinationResponse'

-> PutDestinationResponse

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

PutDestinationResponse, putDestinationResponse_destination - The destination.

$sel:httpStatus:PutDestinationResponse', putDestinationResponse_httpStatus - The response's http status code.

Response Lenses

putDestinationResponse_destination :: Lens' PutDestinationResponse (Maybe Destination)

The destination.

putDestinationResponse_httpStatus :: Lens' PutDestinationResponse Int

The response's http status code.