cdk-iam-floyd
Version:
AWS IAM policy statement generator with fluent interface for AWS CDK
238 lines (237 loc) • 8.72 kB
TypeScript
import { AccessLevelList } from '../../shared/access-level';
import { PolicyStatement, Operator } from '../../shared';
import { aws_iam as iam } from "aws-cdk-lib";
/**
* Statement provider for service [rbin](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsrecyclebin.html).
*
* @param sid [SID](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_sid.html) of the statement
*/
export declare class Rbin extends PolicyStatement {
servicePrefix: string;
/**
* Grants permission to create a Recycle Bin retention rule
*
* Access Level: Write
*
* Possible conditions:
* - .ifAwsRequestTag()
* - .ifAwsTagKeys()
* - .ifRequestResourceType()
*
* https://docs.aws.amazon.com/recyclebin/latest/APIReference/API_CreateRule.html
*/
toCreateRule(): this;
/**
* Grants permission to delete a Recycle Bin retention rule
*
* Access Level: Write
*
* Possible conditions:
* - .ifAwsResourceTag()
* - .ifAttributeResourceType()
*
* https://docs.aws.amazon.com/recyclebin/latest/APIReference/API_DeleteRule.html
*/
toDeleteRule(): this;
/**
* Grants permission to get detailed information about a Recycle Bin retention rule
*
* Access Level: Read
*
* Possible conditions:
* - .ifAwsResourceTag()
* - .ifAttributeResourceType()
*
* https://docs.aws.amazon.com/recyclebin/latest/APIReference/API_GetRule.html
*/
toGetRule(): this;
/**
* Grants permission to list the Recycle Bin retention rules in the Region
*
* Access Level: Read
*
* Possible conditions:
* - .ifRequestResourceType()
*
* https://docs.aws.amazon.com/recyclebin/latest/APIReference/API_ListRules.html
*/
toListRules(): this;
/**
* Grants permission to list the tags associated with a resource
*
* Access Level: Read
*
* Possible conditions:
* - .ifAwsResourceTag()
* - .ifAttributeResourceType()
*
* https://docs.aws.amazon.com/recyclebin/latest/APIReference/API_ListTagsForResource.html
*/
toListTagsForResource(): this;
/**
* Grants permission to lock an existing Recycle Bin retention rule
*
* Access Level: Write
*
* Possible conditions:
* - .ifAwsResourceTag()
* - .ifAttributeResourceType()
*
* https://docs.aws.amazon.com/recyclebin/latest/APIReference/API_LockRule.html
*/
toLockRule(): this;
/**
* Grants permission to add or update tags of a resource
*
* Access Level: Tagging
*
* Possible conditions:
* - .ifAwsRequestTag()
* - .ifAwsResourceTag()
* - .ifAwsTagKeys()
* - .ifAttributeResourceType()
*
* https://docs.aws.amazon.com/recyclebin/latest/APIReference/API_TagResource.html
*/
toTagResource(): this;
/**
* Grants permission to unlock an existing Recycle Bin retention rule
*
* Access Level: Write
*
* Possible conditions:
* - .ifAwsResourceTag()
* - .ifAttributeResourceType()
*
* https://docs.aws.amazon.com/recyclebin/latest/APIReference/API_UnlockRule.html
*/
toUnlockRule(): this;
/**
* Grants permission to remove tags associated with a resource
*
* Access Level: Tagging
*
* Possible conditions:
* - .ifAwsResourceTag()
* - .ifAwsTagKeys()
* - .ifAttributeResourceType()
*
* https://docs.aws.amazon.com/recyclebin/latest/APIReference/API_UntagResource.html
*/
toUntagResource(): this;
/**
* Grants permission to update an existing Recycle Bin retention rule
*
* Access Level: Write
*
* Possible conditions:
* - .ifAwsResourceTag()
* - .ifAttributeResourceType()
*
* https://docs.aws.amazon.com/recyclebin/latest/APIReference/API_UpdateRule.html
*/
toUpdateRule(): this;
protected accessLevelList: AccessLevelList;
/**
* Adds a resource of type rule to the statement
*
* https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/snapshot-recycle-bin.html#recycle-bin-concepts
*
* @param resourceName - Identifier for the resourceName.
* @param account - Account of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's account.
* @param region - Region of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's region.
* @param partition - Partition of the AWS account [aws, aws-cn, aws-us-gov]; defaults to `aws`, unless using the CDK, where the default is the current Stack's partition.
*
* Possible conditions:
* - .ifAwsResourceTag()
*/
onRule(resourceName: string, account?: string, region?: string, partition?: string): this;
/**
* Filters access by a tag's key and value in a request
*
* https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requesttag
*
* Applies to actions:
* - .toCreateRule()
* - .toTagResource()
*
* @param tagKey The tag key to check
* @param value The value(s) to check
* @param operator Works with [string operators](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition_operators.html#Conditions_String). **Default:** `StringLike`
*/
ifAwsRequestTag(tagKey: string, value: string | string[], operator?: Operator | string): this;
/**
* Filters access by the presence of tag key-value pairs in the request
*
* https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag
*
* Applies to actions:
* - .toDeleteRule()
* - .toGetRule()
* - .toListTagsForResource()
* - .toLockRule()
* - .toTagResource()
* - .toUnlockRule()
* - .toUntagResource()
* - .toUpdateRule()
*
* Applies to resource types:
* - rule
*
* @param tagKey The tag key to check
* @param value The value(s) to check
* @param operator Works with [string operators](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition_operators.html#Conditions_String). **Default:** `StringLike`
*/
ifAwsResourceTag(tagKey: string, value: string | string[], operator?: Operator | string): this;
/**
* Filters access by the tag keys in a request
*
* https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-tagkeys
*
* Applies to actions:
* - .toCreateRule()
* - .toTagResource()
* - .toUntagResource()
*
* @param value The value(s) to check
* @param operator Works with [string operators](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition_operators.html#Conditions_String). **Default:** `StringLike`
*/
ifAwsTagKeys(value: string | string[], operator?: Operator | string): this;
/**
* Filters access by the resource type of the existing rule
*
* https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin-perms.html#rbin-condition-keys
*
* Applies to actions:
* - .toDeleteRule()
* - .toGetRule()
* - .toListTagsForResource()
* - .toLockRule()
* - .toTagResource()
* - .toUnlockRule()
* - .toUntagResource()
* - .toUpdateRule()
*
* @param value The value(s) to check
* @param operator Works with [string operators](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition_operators.html#Conditions_String). **Default:** `StringLike`
*/
ifAttributeResourceType(value: string | string[], operator?: Operator | string): this;
/**
* Filters access by the resource type in a request
*
* https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin-perms.html#rbin-condition-keys
*
* Applies to actions:
* - .toCreateRule()
* - .toListRules()
*
* @param value The value(s) to check
* @param operator Works with [string operators](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition_operators.html#Conditions_String). **Default:** `StringLike`
*/
ifRequestResourceType(value: string | string[], operator?: Operator | string): this;
/**
* Statement provider for service [rbin](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsrecyclebin.html).
*
*/
constructor(props?: iam.PolicyStatementProps);
}