put_resource_policy¶
Operation¶
async
¶
put_resource_policy(input: PutResourcePolicyInput, plugins: list[Plugin] | None = None) -> PutResourcePolicyOutput
Attaches a resource-based permission policy to a CloudTrail event data store, dashboard, or channel. For more information about resource-based policies, see CloudTrail resource-based policy examples in the CloudTrail User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
PutResourcePolicyInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
PutResourcePolicyOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for PutResourcePolicyInput structure.
Attributes¶
class-attribute
instance-attribute
¶
resource_arn: str | None = None
The Amazon Resource Name (ARN) of the CloudTrail event data store, dashboard, or channel attached to the resource-based policy.
Example event data store ARN format:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
Example dashboard ARN format:
arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash
Example channel ARN format:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890
class-attribute
instance-attribute
¶
resource_policy: str | None = None
A JSON-formatted string for an Amazon Web Services resource-based policy.
For example resource-based policies, see CloudTrail resource-based policy examples in the CloudTrail User Guide.
Output¶
dataclass
¶
Dataclass for PutResourcePolicyOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
delegated_admin_resource_policy: str | None = None
The default resource-based policy that is automatically generated for the delegated administrator of an Organizations organization. This policy will be evaluated in tandem with any policy you submit for the resource. For more information about this policy, see Default resource policy for delegated administrators.
class-attribute
instance-attribute
¶
resource_arn: str | None = None
The Amazon Resource Name (ARN) of the CloudTrail event data store, dashboard, or channel attached to the resource-based policy.
Example event data store ARN format:
arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE
Example dashboard ARN format:
arn:aws:cloudtrail:us-east-1:123456789012:dashboard/exampleDash
Example channel ARN format:
arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890