libZSservicesZSamazonka-cloudwatch-logsZSamazonka-cloudwatch-logs
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CloudWatchLogs.PutResourcePolicy

Description

Creates or updates a resource policy allowing other Amazon Web Services services to put log events to this account, such as Amazon Route 53. An account can have up to 10 resource policies per Amazon Web Services Region.

Synopsis

Creating a Request

data PutResourcePolicy Source #

See: newPutResourcePolicy smart constructor.

Constructors

PutResourcePolicy' 

Fields

  • policyName :: Maybe Text

    Name of the new policy. This parameter is required.

  • policyDocument :: Maybe Text

    Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string. This parameter is required.

    The following example creates a resource policy enabling the Route 53 service to put DNS query logs in to the specified log group. Replace "logArn" with the ARN of your CloudWatch Logs resource, such as a log group or log stream.

    CloudWatch Logs also supports aws:SourceArn and aws:SourceAccount condition context keys.

    In the example resource policy, you would replace the value of SourceArn with the resource making the call from Route 53 to CloudWatch Logs and replace the value of SourceAccount with the Amazon Web Services account ID making that call.

    { "Version": "2012-10-17", "Statement": [ { "Sid": "Route53LogsToCloudWatchLogs", "Effect": "Allow", "Principal": { "Service": [ "route53.amazonaws.com" ] }, "Action": "logs:PutLogEvents", "Resource": "logArn", "Condition": { "ArnLike": { "aws:SourceArn": "myRoute53ResourceArn" }, "StringEquals": { "aws:SourceAccount": "myAwsAccountId" } } } ] }

Instances

Instances details
Eq PutResourcePolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutResourcePolicy

Read PutResourcePolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutResourcePolicy

Show PutResourcePolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutResourcePolicy

Generic PutResourcePolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutResourcePolicy

Associated Types

type Rep PutResourcePolicy :: Type -> Type #

NFData PutResourcePolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutResourcePolicy

Methods

rnf :: PutResourcePolicy -> () #

Hashable PutResourcePolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutResourcePolicy

ToJSON PutResourcePolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutResourcePolicy

AWSRequest PutResourcePolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutResourcePolicy

Associated Types

type AWSResponse PutResourcePolicy #

ToHeaders PutResourcePolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutResourcePolicy

ToPath PutResourcePolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutResourcePolicy

ToQuery PutResourcePolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutResourcePolicy

type Rep PutResourcePolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutResourcePolicy

type Rep PutResourcePolicy = D1 ('MetaData "PutResourcePolicy" "Amazonka.CloudWatchLogs.PutResourcePolicy" "libZSservicesZSamazonka-cloudwatch-logsZSamazonka-cloudwatch-logs" 'False) (C1 ('MetaCons "PutResourcePolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "policyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "policyDocument") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))
type AWSResponse PutResourcePolicy Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutResourcePolicy

newPutResourcePolicy :: PutResourcePolicy Source #

Create a value of PutResourcePolicy 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:policyName:PutResourcePolicy', putResourcePolicy_policyName - Name of the new policy. This parameter is required.

$sel:policyDocument:PutResourcePolicy', putResourcePolicy_policyDocument - Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string. This parameter is required.

The following example creates a resource policy enabling the Route 53 service to put DNS query logs in to the specified log group. Replace "logArn" with the ARN of your CloudWatch Logs resource, such as a log group or log stream.

CloudWatch Logs also supports aws:SourceArn and aws:SourceAccount condition context keys.

In the example resource policy, you would replace the value of SourceArn with the resource making the call from Route 53 to CloudWatch Logs and replace the value of SourceAccount with the Amazon Web Services account ID making that call.

{ "Version": "2012-10-17", "Statement": [ { "Sid": "Route53LogsToCloudWatchLogs", "Effect": "Allow", "Principal": { "Service": [ "route53.amazonaws.com" ] }, "Action": "logs:PutLogEvents", "Resource": "logArn", "Condition": { "ArnLike": { "aws:SourceArn": "myRoute53ResourceArn" }, "StringEquals": { "aws:SourceAccount": "myAwsAccountId" } } } ] }

Request Lenses

putResourcePolicy_policyName :: Lens' PutResourcePolicy (Maybe Text) Source #

Name of the new policy. This parameter is required.

putResourcePolicy_policyDocument :: Lens' PutResourcePolicy (Maybe Text) Source #

Details of the new policy, including the identity of the principal that is enabled to put logs to this account. This is formatted as a JSON string. This parameter is required.

The following example creates a resource policy enabling the Route 53 service to put DNS query logs in to the specified log group. Replace "logArn" with the ARN of your CloudWatch Logs resource, such as a log group or log stream.

CloudWatch Logs also supports aws:SourceArn and aws:SourceAccount condition context keys.

In the example resource policy, you would replace the value of SourceArn with the resource making the call from Route 53 to CloudWatch Logs and replace the value of SourceAccount with the Amazon Web Services account ID making that call.

{ "Version": "2012-10-17", "Statement": [ { "Sid": "Route53LogsToCloudWatchLogs", "Effect": "Allow", "Principal": { "Service": [ "route53.amazonaws.com" ] }, "Action": "logs:PutLogEvents", "Resource": "logArn", "Condition": { "ArnLike": { "aws:SourceArn": "myRoute53ResourceArn" }, "StringEquals": { "aws:SourceAccount": "myAwsAccountId" } } } ] }

Destructuring the Response

data PutResourcePolicyResponse Source #

See: newPutResourcePolicyResponse smart constructor.

Constructors

PutResourcePolicyResponse' 

Fields

Instances

Instances details
Eq PutResourcePolicyResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutResourcePolicy

Read PutResourcePolicyResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutResourcePolicy

Show PutResourcePolicyResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutResourcePolicy

Generic PutResourcePolicyResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutResourcePolicy

Associated Types

type Rep PutResourcePolicyResponse :: Type -> Type #

NFData PutResourcePolicyResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutResourcePolicy

type Rep PutResourcePolicyResponse Source # 
Instance details

Defined in Amazonka.CloudWatchLogs.PutResourcePolicy

type Rep PutResourcePolicyResponse = D1 ('MetaData "PutResourcePolicyResponse" "Amazonka.CloudWatchLogs.PutResourcePolicy" "libZSservicesZSamazonka-cloudwatch-logsZSamazonka-cloudwatch-logs" 'False) (C1 ('MetaCons "PutResourcePolicyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourcePolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourcePolicy)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPutResourcePolicyResponse Source #

Create a value of PutResourcePolicyResponse 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:resourcePolicy:PutResourcePolicyResponse', putResourcePolicyResponse_resourcePolicy - The new policy.

$sel:httpStatus:PutResourcePolicyResponse', putResourcePolicyResponse_httpStatus - The response's http status code.

Response Lenses