cdk-iam-floyd
Version:
AWS IAM policy statement generator with fluent interface for AWS CDK
278 lines (277 loc) • 11.2 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 [aws-marketplace-catalog](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsmarketplacecatalog.html).
*
* @param sid [SID](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_sid.html) of the statement
*/
export declare class AwsMarketplaceCatalog extends PolicyStatement {
servicePrefix: string;
/**
* Grants permission to cancel a running change set
*
* Access Level: Write
*
* https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_CancelChangeSet.html
*/
toCancelChangeSet(): this;
/**
* Grants permission to complete an existing task and submit the content to the associated change
*
* Access Level: Write
*
* https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/
*/
toCompleteTask(): this;
/**
* Grants permission to delete the resource policy of an existing entity
*
* Access Level: Permissions management
*
* https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DeleteResourcePolicy.html
*/
toDeleteResourcePolicy(): this;
/**
* Grants permission to return the details of an existing assessment
*
* Access Level: Read
*
* https://docs.aws.amazon.com/marketplace/latest/userguide/detailed-management-portal-permissions.html
*/
toDescribeAssessment(): this;
/**
* Grants permission to return the details of an existing change set
*
* Access Level: Read
*
* https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeChangeSet.html
*/
toDescribeChangeSet(): this;
/**
* Grants permission to return the details of an existing entity
*
* Access Level: Read
*
* https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeEntity.html
*/
toDescribeEntity(): this;
/**
* Grants permission to return the details of an existing task
*
* Access Level: Read
*
* https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/
*/
toDescribeTask(): this;
/**
* Grants permission to get the resource policy of an existing entity
*
* Access Level: Read
*
* https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_GetResourcePolicy.html
*/
toGetResourcePolicy(): this;
/**
* Grants permission to list existing assessments
*
* Access Level: List
*
* https://docs.aws.amazon.com/marketplace/latest/userguide/detailed-management-portal-permissions.html
*/
toListAssessments(): this;
/**
* Grants permission to list existing change sets
*
* Access Level: List
*
* https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_ListChangeSets.html
*/
toListChangeSets(): this;
/**
* Grants permission to list existing entities
*
* Access Level: List
*
* https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_ListEntities.html
*/
toListEntities(): this;
/**
* Grants permission to list tags on an existing entity or a change set
*
* Access Level: Read
*
* https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_ListTagsForResource.html
*/
toListTagsForResource(): this;
/**
* Grants permission to list existing tasks
*
* Access Level: List
*
* https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/
*/
toListTasks(): this;
/**
* Grants permission to attach a resource policy to an existing entity
*
* Access Level: Permissions management
*
* https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_PutResourcePolicy.html
*/
toPutResourcePolicy(): this;
/**
* Grants permission to request a new change set (Note: resource-level permissions for this action and condition context keys for this action are only supported when used with Catalog API and are not supported when used with AWS Marketplace Management Portal)
*
* Access Level: Write
*
* Possible conditions:
* - .ifCatalogChangeType()
* - .ifIntent()
* - .ifAwsRequestTag()
* - .ifAwsTagKeys()
*
* https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_StartChangeSet.html
*/
toStartChangeSet(): this;
/**
* Grants permission to tag an existing entity or a change set
*
* Access Level: Tagging
*
* Possible conditions:
* - .ifAwsTagKeys()
* - .ifAwsRequestTag()
*
* https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_TagResource.html
*/
toTagResource(): this;
/**
* Grants permission to untag an existing entity or a change set
*
* Access Level: Tagging
*
* Possible conditions:
* - .ifAwsTagKeys()
*
* https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_UntagResource.html
*/
toUntagResource(): this;
/**
* Grants permission to update the contents of an existing task
*
* Access Level: Write
*
* https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/
*/
toUpdateTask(): this;
protected accessLevelList: AccessLevelList;
/**
* Adds a resource of type Entity to the statement
*
* https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_DescribeEntity.html#API_DescribeEntity_ResponseSyntax
*
* @param catalog - Identifier for the catalog.
* @param entityType - Identifier for the entityType.
* @param resourceId - Identifier for the resourceId.
* @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()
* - .ifCatalogChangeType()
*/
onEntity(catalog: string, entityType: string, resourceId: string, account?: string, region?: string, partition?: string): this;
/**
* Adds a resource of type ChangeSet to the statement
*
* https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/API_StartChangeSet.html#API_StartChangeSet_ResponseSyntax
*
* @param catalog - Identifier for the catalog.
* @param resourceId - Identifier for the resourceId.
* @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()
* - .ifCatalogChangeType()
*/
onChangeSet(catalog: string, resourceId: string, account?: string, region?: string, partition?: string): this;
/**
* Filters access by the Intent parameter in the StartChangeSet request
*
* https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/api-access-control.html
*
* Applies to actions:
* - .toStartChangeSet()
*
* @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`
*/
ifIntent(value: string | string[], operator?: Operator | string): this;
/**
* Filters access by the tags that are passed in the request
*
* https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requesttag
*
* Applies to actions:
* - .toStartChangeSet()
* - .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 tags associated with the resource
*
* https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag
*
* Applies to resource types:
* - Entity
* - ChangeSet
*
* @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 that are passed in the request
*
* https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-tagkeys
*
* Applies to actions:
* - .toStartChangeSet()
* - .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 change type in the StartChangeSet request
*
* https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/api-access-control.html
*
* Applies to actions:
* - .toStartChangeSet()
*
* Applies to resource types:
* - Entity
* - ChangeSet
*
* @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`
*/
ifCatalogChangeType(value: string | string[], operator?: Operator | string): this;
/**
* Statement provider for service [aws-marketplace-catalog](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsmarketplacecatalog.html).
*
*/
constructor(props?: iam.PolicyStatementProps);
}