cdk-iam-floyd
Version:
AWS IAM policy statement generator with fluent interface for AWS CDK
447 lines (446 loc) • 16.7 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 [iotevents](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotevents.html).
*
* @param sid [SID](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_sid.html) of the statement
*/
export declare class Iotevents extends PolicyStatement {
servicePrefix: string;
/**
* Grants permission to send one or more acknowledge action requests to AWS IoT Events
*
* Access Level: Write
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchAcknowledgeAlarm.html
*/
toBatchAcknowledgeAlarm(): this;
/**
* Grants permission to delete a detector instance within the AWS IoT Events system
*
* Access Level: Write
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchDeleteDetector.html
*/
toBatchDeleteDetector(): this;
/**
* Grants permission to disable one or more alarm instances
*
* Access Level: Write
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchDisableAlarm.html
*/
toBatchDisableAlarm(): this;
/**
* Grants permission to enable one or more alarm instances
*
* Access Level: Write
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchEnableAlarm.html
*/
toBatchEnableAlarm(): this;
/**
* Grants permission to send a set of messages to the AWS IoT Events system
*
* Access Level: Write
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchPutMessage.html
*/
toBatchPutMessage(): this;
/**
* Grants permission to reset one or more alarm instances
*
* Access Level: Write
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchResetAlarm.html
*/
toBatchResetAlarm(): this;
/**
* Grants permission to change one or more alarm instances to the snooze mode
*
* Access Level: Write
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchSnoozeAlarm.html
*/
toBatchSnoozeAlarm(): this;
/**
* Grants permission to update a detector instance within the AWS IoT Events system
*
* Access Level: Write
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_BatchUpdateDetector.html
*/
toBatchUpdateDetector(): this;
/**
* Grants permission to create an alarm model to monitor an AWS IoT Events input attribute or an AWS IoT SiteWise asset property
*
* Access Level: Write
*
* Possible conditions:
* - .ifAwsRequestTag()
* - .ifAwsTagKeys()
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateAlarmModel.html
*/
toCreateAlarmModel(): this;
/**
* Grants permission to create a detector model to monitor an AWS IoT Events input attribute
*
* Access Level: Write
*
* Possible conditions:
* - .ifAwsRequestTag()
* - .ifAwsTagKeys()
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateDetectorModel.html
*/
toCreateDetectorModel(): this;
/**
* Grants permission to create an Input in IotEvents
*
* Access Level: Write
*
* Possible conditions:
* - .ifAwsRequestTag()
* - .ifAwsTagKeys()
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_CreateInput.html
*/
toCreateInput(): this;
/**
* Grants permission to delete an alarm model
*
* Access Level: Write
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_DeleteAlarmModel.html
*/
toDeleteAlarmModel(): this;
/**
* Grants permission to delete a detector model
*
* Access Level: Write
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_DeleteDetectorModel.html
*/
toDeleteDetectorModel(): this;
/**
* Grants permission to delete an input
*
* Access Level: Write
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_DeleteInput.html
*/
toDeleteInput(): this;
/**
* Grants permission to retrieve information about an alarm instance
*
* Access Level: Read
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_DescribeAlarm.html
*/
toDescribeAlarm(): this;
/**
* Grants permission to retrieve information about an alarm model
*
* Access Level: Read
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_DescribeAlarmModel.html
*/
toDescribeAlarmModel(): this;
/**
* Grants permission to retriev information about a detector instance
*
* Access Level: Read
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_DescribeDetector.html
*/
toDescribeDetector(): this;
/**
* Grants permission to retrieve information about a detector model
*
* Access Level: Read
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_DescribeDetectorModel.html
*/
toDescribeDetectorModel(): this;
/**
* Grants permission to retrieve the detector model analysis information
*
* Access Level: Read
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_DescribeDetectorModelAnalysis.html
*/
toDescribeDetectorModelAnalysis(): this;
/**
* Grants permission to retrieve an information about Input
*
* Access Level: Read
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_DescribeInput.html
*/
toDescribeInput(): this;
/**
* Grants permission to retrieve the current settings of the AWS IoT Events logging options
*
* Access Level: Read
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_DescribeLoggingOptions.html
*/
toDescribeLoggingOptions(): this;
/**
* Grants permission to retrieve the detector model analysis results
*
* Access Level: Read
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_GetDetectorModelAnalysisResults.html
*/
toGetDetectorModelAnalysisResults(): this;
/**
* Grants permission to list all the versions of an alarm model
*
* Access Level: List
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_ListAlarmModelVersions.html
*/
toListAlarmModelVersions(): this;
/**
* Grants permission to list the alarm models that you created
*
* Access Level: List
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_ListAlarmModels.html
*/
toListAlarmModels(): this;
/**
* Grants permission to retrieve information about all alarm instances per alarmModel
*
* Access Level: List
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_ListAlarms.html
*/
toListAlarms(): this;
/**
* Grants permission to list all the versions of a detector model
*
* Access Level: List
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_ListDetectorModelVersions.html
*/
toListDetectorModelVersions(): this;
/**
* Grants permission to list the detector models that you created
*
* Access Level: List
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_ListDetectorModels.html
*/
toListDetectorModels(): this;
/**
* Grants permission to retrieve information about all detector instances per detectormodel
*
* Access Level: List
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_iotevents-data_ListDetectors.html
*/
toListDetectors(): this;
/**
* Grants permission to list one or more input routings
*
* Access Level: List
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_ListInputRoutings.html
*/
toListInputRoutings(): this;
/**
* Grants permission to lists the inputs you have created
*
* Access Level: List
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_ListInputs.html
*/
toListInputs(): this;
/**
* Grants permission to list the tags (metadata) which you have assigned to the resource
*
* Access Level: Read
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_ListTagsForResource.html
*/
toListTagsForResource(): this;
/**
* Grants permission to set or update the AWS IoT Events logging options
*
* Access Level: Write
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_PutLoggingOptions.html
*/
toPutLoggingOptions(): this;
/**
* Grants permission to start the detector model analysis
*
* Access Level: Write
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_StartDetectorModelAnalysis.html
*/
toStartDetectorModelAnalysis(): this;
/**
* Grants permission to adds to or modifies the tags of the given resource.Tags are metadata which can be used to manage a resource
*
* Access Level: Tagging
*
* Possible conditions:
* - .ifAwsRequestTag()
* - .ifAwsTagKeys()
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_TagResource.html
*/
toTagResource(): this;
/**
* Grants permission to remove the given tags (metadata) from the resource
*
* Access Level: Tagging
*
* Possible conditions:
* - .ifAwsTagKeys()
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_UntagResource.html
*/
toUntagResource(): this;
/**
* Grants permission to update an alarm model
*
* Access Level: Write
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_UpdateAlarmModel.html
*/
toUpdateAlarmModel(): this;
/**
* Grants permission to update a detector model
*
* Access Level: Write
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_UpdateDetectorModel.html
*/
toUpdateDetectorModel(): this;
/**
* Grants permission to update an input
*
* Access Level: Write
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_UpdateInput.html
*/
toUpdateInput(): this;
/**
* Grants permission to update input routing
*
* Access Level: Write
*
* https://docs.aws.amazon.com/iotevents/latest/apireference/API_UpdateInputRouting.html
*/
toUpdateInputRouting(): this;
protected accessLevelList: AccessLevelList;
/**
* Adds a resource of type detectorModel to the statement
*
* https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-getting-started.html
*
* @param detectorModelName - Identifier for the detectorModelName.
* @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()
*/
onDetectorModel(detectorModelName: string, account?: string, region?: string, partition?: string): this;
/**
* Adds a resource of type alarmModel to the statement
*
* https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-getting-started.html
*
* @param alarmModelName - Identifier for the alarmModelName.
* @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()
*/
onAlarmModel(alarmModelName: string, account?: string, region?: string, partition?: string): this;
/**
* Adds a resource of type input to the statement
*
* https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-getting-started.html
*
* @param inputName - Identifier for the inputName.
* @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()
*/
onInput(inputName: string, account?: string, region?: string, partition?: string): this;
/**
* Filters access by the tag key-value pairs in the request
*
* https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-requesttag
*
* Applies to actions:
* - .toCreateAlarmModel()
* - .toCreateDetectorModel()
* - .toCreateInput()
* - .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 attached to the resource
*
* https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-resourcetag
*
* Applies to resource types:
* - detectorModel
* - alarmModel
* - input
*
* @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 by the tag keys in the request
*
* https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-tagkeys
*
* Applies to actions:
* - .toCreateAlarmModel()
* - .toCreateDetectorModel()
* - .toCreateInput()
* - .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 instanceId (key-value) of the message
*
* https://docs.aws.amazon.com/iotevents/latest/developerguide/security_iam_id-based-policy-examples.html#security_iam_service-with-iam-id-based-policies-conditionkeys
*
* @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`
*/
ifKeyValue(value: string | string[], operator?: Operator | string): this;
/**
* Statement provider for service [iotevents](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotevents.html).
*
*/
constructor(props?: iam.PolicyStatementProps);
}