UNPKG

cdk-iam-floyd

Version:

AWS IAM policy statement generator with fluent interface for AWS CDK

180 lines (179 loc) 7.26 kB
import { AccessLevelList } from '../../shared/access-level'; import { PolicyStatement, Operator } from '../../shared'; import { aws_iam as iam } from "aws-cdk-lib"; /** * Statement provider for service [firehose](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonkinesisfirehose.html). * * @param sid [SID](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_sid.html) of the statement */ export declare class Firehose extends PolicyStatement { servicePrefix: string; /** * Grants permission to create a delivery stream * * Access Level: Write * * Possible conditions: * - .ifAwsRequestTag() * - .ifAwsTagKeys() * * https://docs.aws.amazon.com/firehose/latest/APIReference/API_CreateDeliveryStream.html */ toCreateDeliveryStream(): this; /** * Grants permission to delete a delivery stream and its data * * Access Level: Write * * https://docs.aws.amazon.com/firehose/latest/APIReference/API_DeleteDeliveryStream.html */ toDeleteDeliveryStream(): this; /** * Grants permission to describe the specified delivery stream and gets the status * * Access Level: Read * * https://docs.aws.amazon.com/firehose/latest/APIReference/API_DescribeDeliveryStream.html */ toDescribeDeliveryStream(): this; /** * Grants permission to list your delivery streams * * Access Level: List * * https://docs.aws.amazon.com/firehose/latest/APIReference/API_ListDeliveryStreams.html */ toListDeliveryStreams(): this; /** * Grants permission to list the tags for the specified delivery stream * * Access Level: List * * https://docs.aws.amazon.com/firehose/latest/APIReference/API_ListTagsForDeliveryStream.html */ toListTagsForDeliveryStream(): this; /** * Grants permission to write a single data record into an Amazon Kinesis Firehose delivery stream * * Access Level: Write * * https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecord.html */ toPutRecord(): this; /** * Grants permission to write multiple data records into a delivery stream in a single call, which can achieve higher throughput per producer than when writing single records * * Access Level: Write * * https://docs.aws.amazon.com/firehose/latest/APIReference/API_PutRecordBatch.html */ toPutRecordBatch(): this; /** * Grants permission to enable server-side encryption (SSE) for the delivery stream * * Access Level: Write * * https://docs.aws.amazon.com/firehose/latest/APIReference/API_StartDeliveryStreamEncryption.html */ toStartDeliveryStreamEncryption(): this; /** * Grants permission to disable the specified destination of the specified delivery stream * * Access Level: Write * * https://docs.aws.amazon.com/firehose/latest/APIReference/API_StopDeliveryStreamEncryption.html */ toStopDeliveryStreamEncryption(): this; /** * Grants permission to add or update tags for the specified delivery stream * * Access Level: Tagging * * Possible conditions: * - .ifAwsRequestTag() * - .ifAwsTagKeys() * * https://docs.aws.amazon.com/firehose/latest/APIReference/API_TagDeliveryStream.html */ toTagDeliveryStream(): this; /** * Grants permission to remove tags from the specified delivery stream * * Access Level: Tagging * * Possible conditions: * - .ifAwsTagKeys() * * https://docs.aws.amazon.com/firehose/latest/APIReference/API_UntagDeliveryStream.html */ toUntagDeliveryStream(): this; /** * Grants permission to update the specified destination of the specified delivery stream * * Access Level: Write * * https://docs.aws.amazon.com/firehose/latest/APIReference/API_UpdateDestination.html */ toUpdateDestination(): this; protected accessLevelList: AccessLevelList; /** * Adds a resource of type deliverystream to the statement * * https://docs.aws.amazon.com/firehose/latest/dev/basic-create.html * * @param deliveryStreamName - Identifier for the deliveryStreamName. * @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() */ onDeliverystream(deliveryStreamName: string, account?: string, region?: string, partition?: string): this; /** * Filters actions based on 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: * - .toCreateDeliveryStream() * - .toTagDeliveryStream() * * @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 actions based on 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: * - deliverystream * * @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 actions based on 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: * - .toCreateDeliveryStream() * - .toTagDeliveryStream() * - .toUntagDeliveryStream() * * @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; /** * Statement provider for service [firehose](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonkinesisfirehose.html). * */ constructor(props?: iam.PolicyStatementProps); }