UNPKG

cdk-iam-floyd

Version:

AWS IAM policy statement generator with fluent interface for AWS CDK

467 lines (466 loc) 18.2 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 [ssm-contacts](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssystemsmanagerincidentmanagercontacts.html). * * @param sid [SID](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_sid.html) of the statement */ export declare class SsmContacts extends PolicyStatement { servicePrefix: string; /** * Grants permission to accept a page * * Access Level: Write * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_AcceptPage.html */ toAcceptPage(): this; /** * Grants permission to activate a contact's contact channel * * Access Level: Write * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_ActivateContactChannel.html */ toActivateContactChannel(): this; /** * Grants permission to use a contact in an escalation plan * * Access Level: Permissions management * * https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html */ toAssociateContact(): this; /** * Grants permission to create a contact * * Access Level: Write * * Possible conditions: * - .ifAwsTagKeys() * - .ifAwsRequestTag() * * Dependent actions: * - ssm-contacts:AssociateContact * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_CreateContact.html */ toCreateContact(): this; /** * Grants permission to create a contact channel for a contact * * Access Level: Write * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_CreateContactChannel.html */ toCreateContactChannel(): this; /** * Grants permission to create a rotation in an on-call schedule * * Access Level: Write * * Possible conditions: * - .ifAwsTagKeys() * - .ifAwsRequestTag() * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_CreateRotation.html */ toCreateRotation(): this; /** * Grants permission to create an override for a rotation in an on-call schedule * * Access Level: Write * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_CreateRotationOverride.html */ toCreateRotationOverride(): this; /** * Grants permission to deactivate a contact's contact channel * * Access Level: Write * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_DeactivateContactChannel.html */ toDeactivateContactChannel(): this; /** * Grants permission to delete a contact * * Access Level: Write * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_DeleteContact.html */ toDeleteContact(): this; /** * Grants permission to delete a contact's contact channel * * Access Level: Write * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_DeleteContactChannel.html */ toDeleteContactChannel(): this; /** * Grants permission to delete a rotation * * Access Level: Write * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_DeleteRotation.html */ toDeleteRotation(): this; /** * Grants permission to delete a rotation's rotation override * * Access Level: Write * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_DeleteRotationOverride.html */ toDeleteRotationOverride(): this; /** * Grants permission to describe an engagement * * Access Level: Read * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_DescribeEngagement.html */ toDescribeEngagement(): this; /** * Grants permission to describe a page * * Access Level: Read * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_DescribePage.html */ toDescribePage(): this; /** * Grants permission to get a contact * * Access Level: Read * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_GetContact.html */ toGetContact(): this; /** * Grants permission to get a contact's contact channel * * Access Level: Read * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_GetContactChannel.html */ toGetContactChannel(): this; /** * Grants permission to get a contact's resource policy * * Access Level: Read * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_GetContactPolicy.html */ toGetContactPolicy(): this; /** * Grants permission to retrieve information about an on-call rotation * * Access Level: Read * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_GetRotation.html */ toGetRotation(): this; /** * Grants permission to retrieve information about an override in an on-call rotation * * Access Level: Read * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_GetRotationOverride.html */ toGetRotationOverride(): this; /** * Grants permission to list all of a contact's contact channels * * Access Level: List * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_ListContactChannels.html */ toListContactChannels(): this; /** * Grants permission to list all contacts * * Access Level: List * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_ListContacts.html */ toListContacts(): this; /** * Grants permission to list all engagements * * Access Level: List * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_ListEngagements.html */ toListEngagements(): this; /** * Grants permission to list all receipts of a page * * Access Level: List * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_ListPageReceipts.html */ toListPageReceipts(): this; /** * Grants permission to list the resolution path of an engagement * * Access Level: List * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_ListPageResolutions.html */ toListPageResolutions(): this; /** * Grants permission to list all pages sent to a contact * * Access Level: List * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_ListPagesByContact.html */ toListPagesByContact(): this; /** * Grants permission to list all pages created in an engagement * * Access Level: List * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_ListPagesByEngagement.html */ toListPagesByEngagement(): this; /** * Grants permission to retrieve a list of shifts based on rotation configuration parameters * * Access Level: List * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_ListPreviewRotationShifts.html */ toListPreviewRotationShifts(): this; /** * Grants permission to retrieve a list of overrides currently specified for an on-call rotation * * Access Level: List * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_ListRotationOverrides.html */ toListRotationOverrides(): this; /** * Grants permission to retrieve a list of rotation shifts in an on-call schedule * * Access Level: List * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_ListRotationShifts.html */ toListRotationShifts(): this; /** * Grants permission to retrieve a list of on-call rotations * * Access Level: List * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_ListRotations.html */ toListRotations(): this; /** * Grants permission to view a list of resource tags for a specified resource * * Access Level: Read * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_ListTagsForResource.html */ toListTagsForResource(): this; /** * Grants permission to add a resource policy to a contact * * Access Level: Write * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_PutContactPolicy.html */ toPutContactPolicy(): this; /** * Grants permission to send the activation code of a contact's contact channel * * Access Level: Write * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_SendActivationCode.html */ toSendActivationCode(): this; /** * Grants permission to start an engagement * * Access Level: Write * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_StartEngagement.html */ toStartEngagement(): this; /** * Grants permission to stop an engagement * * Access Level: Write * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_StopEngagement.html */ toStopEngagement(): this; /** * Grants permission to add tags to the specified resource * * Access Level: Tagging * * Possible conditions: * - .ifAwsTagKeys() * - .ifAwsRequestTag() * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_TagResource.html */ toTagResource(): this; /** * Grants permission to remove tags from the specified resource * * Access Level: Tagging * * Possible conditions: * - .ifAwsTagKeys() * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_UntagResource.html */ toUntagResource(): this; /** * Grants permission to update a contact * * Access Level: Write * * Dependent actions: * - ssm-contacts:AssociateContact * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_UpdateContact.html */ toUpdateContact(): this; /** * Grants permission to update a contact's contact channel * * Access Level: Write * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_UpdateContactChannel.html */ toUpdateContactChannel(): this; /** * Grants permission to update the information specified for an on-call rotation * * Access Level: Write * * https://docs.aws.amazon.com/incident-manager/latest/APIReference/API_SSMContacts_UpdateRotation.html */ toUpdateRotation(): this; protected accessLevelList: AccessLevelList; /** * Adds a resource of type contact to the statement * * https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html * * @param contactAlias - Identifier for the contactAlias. * @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() */ onContact(contactAlias: string, account?: string, region?: string, partition?: string): this; /** * Adds a resource of type contactchannel to the statement * * https://docs.aws.amazon.com/incident-manager/latest/userguide/contacts.html * * @param contactAlias - Identifier for the contactAlias. * @param contactChannelId - Identifier for the contactChannelId. * @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. */ onContactchannel(contactAlias: string, contactChannelId: string, account?: string, region?: string, partition?: string): this; /** * Adds a resource of type engagement to the statement * * https://docs.aws.amazon.com/incident-manager/latest/userguide/escalation.html * * @param contactAlias - Identifier for the contactAlias. * @param engagementId - Identifier for the engagementId. * @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. */ onEngagement(contactAlias: string, engagementId: string, account?: string, region?: string, partition?: string): this; /** * Adds a resource of type page to the statement * * https://docs.aws.amazon.com/incident-manager/latest/userguide/escalation.html * * @param contactAlias - Identifier for the contactAlias. * @param pageId - Identifier for the pageId. * @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. */ onPage(contactAlias: string, pageId: string, account?: string, region?: string, partition?: string): this; /** * Adds a resource of type rotation to the statement * * https://docs.aws.amazon.com/incident-manager/latest/userguide/incident-manager-on-call-schedule.html * * @param rotationId - Identifier for the rotationId. * @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() */ onRotation(rotationId: string, account?: string, region?: string, partition?: 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: * - .toCreateContact() * - .toCreateRotation() * - .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: * - contact * - rotation * * @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: * - .toCreateContact() * - .toCreateRotation() * - .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; /** * Statement provider for service [ssm-contacts](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssystemsmanagerincidentmanagercontacts.html). * */ constructor(props?: iam.PolicyStatementProps); }