PutResolverRulePolicy - Amazon Route 53

PutResolverRulePolicy

Specifies an AWS rule that you want to share with another account, the account that you want to share the rule with, and the operations that you want the account to be able to perform on the rule.

Request Syntax

{ "Arn": "string", "ResolverRulePolicy": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Arn

The Amazon Resource Name (ARN) of the rule that you want to share with another account.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

ResolverRulePolicy

An AWS Identity and Access Management policy statement that lists the rules that you want to share with another AWS account and the operations that you want the account to be able to perform. You can specify the following operations in the Action section of the statement:

  • route53resolver:GetResolverRule

  • route53resolver:AssociateResolverRule

  • route53resolver:DisassociateResolverRule

  • route53resolver:ListResolverRules

  • route53resolver:ListResolverRuleAssociations

In the Resource section of the statement, specify the ARN for the rule that you want to share with another account. Specify the same ARN that you specified in Arn.

Type: String

Length Constraints: Maximum length of 5000.

Required: Yes

Response Syntax

{ "ReturnValue": boolean }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ReturnValue

Whether the PutResolverRulePolicy request was successful.

Type: Boolean

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceErrorException

We encountered an unknown error. Try again in a few minutes.

HTTP Status Code: 400

InvalidParameterException

One or more parameters in this request are not valid.

HTTP Status Code: 400

InvalidPolicyDocument

The specified Resolver rule policy is invalid.

HTTP Status Code: 400

UnknownResourceException

The specified resource doesn't exist.

HTTP Status Code: 400

Examples

PutResolverRulePolicy Example

This example illustrates one usage of PutResolverRulePolicy.

Sample Request

POST / HTTP/1.1 Host: route53resolver.us-east-2.amazonaws.com Accept-Encoding: identity Content-Length: 2 X-Amz-Target: Route53Resolver.PutResolverRulePolicy X-Amz-Date: 20181101T192600Z User-Agent: aws-cli/1.16.45 Python/2.7.10 Darwin/16.7.0 botocore/1.12.35 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAJJ2SONIPEXAMPLE/20181101/us-east-2/route53resolver/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=[calculated-signature] { "Arn": "arn:aws:route53resolver:us-east-2:123456789012:resolver-rule/rslvr-rr-5328a0899aexample", "ResolverRulePolicy": "{ "Version": "2012-10-17", "Statement": [ { "Effect" : "Allow", "Principal" : {"AWS" : [ "123456789012" ] }, "Action" : [ "route53resolver:GetResolverRule", "route53resolver:AssociateResolverRule", "route53resolver:DisassociateResolverRule", "route53resolver:ListResolverRules", "route53resolver:ListResolverRuleAssociations" ], "Resource" : [ "arn:aws:route53resolver:us-east-2:123456789012:resolver-rule/rslvr-rr-5328a0899aexample" ] } ] }" }

Sample Response

HTTP/1.1 200 OK Date: Thu, 01 Nov 2018 19:26:00 GMT Content-Type: application/x-amz-json-1.1 Content-Length: 27 x-amzn-RequestId: cfa09aaa-6619-40d4-8791-064c6example Connection: keep-alive { "ReturnValue": true }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: