interface AddToResourcePolicyResult

Language	Type name
.NET	Amazon.CDK.AWS.IAM.AddToResourcePolicyResult
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsiam#AddToResourcePolicyResult
Java	software.amazon.awscdk.services.iam.AddToResourcePolicyResult
Python	aws_cdk.aws_iam.AddToResourcePolicyResult
TypeScript (source)	aws-cdk-lib » aws_iam » AddToResourcePolicyResult

Obtainable from RestApi.addToResourcePolicy(), RestApiBase.addToResourcePolicy(), SpecRestApi.addToResourcePolicy(), Table.addToResourcePolicy(), TableBase.addToResourcePolicy(), TableBaseV2.addToResourcePolicy(), TableV2.addToResourcePolicy(), Repository.addToResourcePolicy(), RepositoryBase.addToResourcePolicy(), FileSystem.addToResourcePolicy(), EventBus.addToResourcePolicy(), Stream.addToResourcePolicy(), StreamConsumer.addToResourcePolicy(), Alias.addToResourcePolicy(), Key.addToResourcePolicy(), LogGroup.addToResourcePolicy(), BucketBase.addToResourcePolicy(), Secret.addToResourcePolicy(), SecretTargetAttachment.addToResourcePolicy(), TopicBase.addToResourcePolicy(), QueueBase.addToResourcePolicy(), Table.addToResourcePolicy(), TableBucket.addToResourcePolicy()

Result of calling addToResourcePolicy.

Example

const bucket = s3.Bucket.fromBucketName(this, 'existingBucket', 'amzn-s3-demo-bucket');

// No policy statement will be added to the resource
const result = bucket.addToResourcePolicy(
  new iam.PolicyStatement({
    actions: ['s3:GetObject'],
    resources: [bucket.arnForObjects('file.txt')],
    principals: [new iam.AccountRootPrincipal()],
  })
);

Properties

Name	Type	Description
statementAdded	boolean	Whether the statement was added.
policyDependable?	IDependable	Dependable which allows depending on the policy change being applied.

---

statementAdded

Type: boolean

Whether the statement was added.

---

policyDependable?

Type: IDependable (optional, default: If statementAdded is true, the resource object itself. Otherwise, no dependable.)

Dependable which allows depending on the policy change being applied.