cdk-iam-floyd
Version:
AWS IAM policy statement generator with fluent interface for AWS CDK
616 lines (615 loc) • 23.1 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 [amplifyuibuilder](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsamplifyuibuilder.html).
*
* @param sid [SID](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_sid.html) of the statement
*/
export declare class Amplifyuibuilder extends PolicyStatement {
servicePrefix: string;
/**
* Grants permission to create a component
*
* Access Level: Write
*
* Possible conditions:
* - .ifAwsRequestTag()
* - .ifAwsTagKeys()
*
* Dependent actions:
* - amplify:GetApp
* - amplifyuibuilder:GetComponent
* - amplifyuibuilder:TagResource
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_CreateComponent.html
*/
toCreateComponent(): this;
/**
* Grants permission to create a form
*
* Access Level: Write
*
* Possible conditions:
* - .ifAwsRequestTag()
* - .ifAwsTagKeys()
*
* Dependent actions:
* - amplify:GetApp
* - amplifyuibuilder:GetForm
* - amplifyuibuilder:TagResource
* - amplifyuibuilder:UntagResource
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_CreateForm.html
*/
toCreateForm(): this;
/**
* Grants permission to create a theme
*
* Access Level: Write
*
* Possible conditions:
* - .ifAwsRequestTag()
* - .ifAwsTagKeys()
*
* Dependent actions:
* - amplify:GetApp
* - amplifyuibuilder:GetTheme
* - amplifyuibuilder:TagResource
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_CreateTheme.html
*/
toCreateTheme(): this;
/**
* Grants permission to delete a component
*
* Access Level: Write
*
* Dependent actions:
* - amplify:GetApp
* - amplifyuibuilder:UntagResource
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_DeleteComponent.html
*/
toDeleteComponent(): this;
/**
* Grants permission to delete a form
*
* Access Level: Write
*
* Dependent actions:
* - amplify:GetApp
* - amplifyuibuilder:TagResource
* - amplifyuibuilder:UntagResource
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_DeleteForm.html
*/
toDeleteForm(): this;
/**
* Grants permission to delete a theme
*
* Access Level: Write
*
* Dependent actions:
* - amplify:GetApp
* - amplifyuibuilder:UntagResource
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_DeleteTheme.html
*/
toDeleteTheme(): this;
/**
* Grants permission to exchange a code for a token
*
* Access Level: Write
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_ExchangeCodeForToken.html
*/
toExchangeCodeForToken(): this;
/**
* Grants permission to export components
*
* Access Level: Read
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_ExportComponents.html
*/
toExportComponents(): this;
/**
* Grants permission to export forms
*
* Access Level: Read
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_ExportForms.html
*/
toExportForms(): this;
/**
* Grants permission to export themes
*
* Access Level: Read
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_ExportThemes.html
*/
toExportThemes(): this;
/**
* Grants permission to get an existing codegen job
*
* Access Level: Read
*
* Dependent actions:
* - amplify:GetApp
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_GetCodegenJob.html
*/
toGetCodegenJob(): this;
/**
* Grants permission to get an existing component
*
* Access Level: Read
*
* Dependent actions:
* - amplify:GetApp
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_GetComponent.html
*/
toGetComponent(): this;
/**
* Grants permission to get an existing form
*
* Access Level: Read
*
* Dependent actions:
* - amplify:GetApp
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_GetForm.html
*/
toGetForm(): this;
/**
* Grants permission to get an existing metadata
*
* Access Level: Read
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_GetMetadata.html
*/
toGetMetadata(): this;
/**
* Grants permission to get an existing theme
*
* Access Level: Read
*
* Dependent actions:
* - amplify:GetApp
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_GetTheme.html
*/
toGetTheme(): this;
/**
* Grants permission to list codegen jobs
*
* Access Level: List
*
* Dependent actions:
* - amplify:GetApp
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_ListCodegenJobs.html
*/
toListCodegenJobs(): this;
/**
* Grants permission to list components
*
* Access Level: List
*
* Dependent actions:
* - amplify:GetApp
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_ListComponents.html
*/
toListComponents(): this;
/**
* Grants permission to list forms
*
* Access Level: List
*
* Dependent actions:
* - amplify:GetApp
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_ListForms.html
*/
toListForms(): this;
/**
* Grants permission to list tags for a specified Amazon Resource Name (ARN)
*
* Access Level: List
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_ListTagsForResource.html
*/
toListTagsForResource(): this;
/**
* Grants permission to list themes
*
* Access Level: List
*
* Dependent actions:
* - amplify:GetApp
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_ListThemes.html
*/
toListThemes(): this;
/**
* Grants permission to put an existing metadata
*
* Access Level: Write
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_PutMetadataFlag.html
*/
toPutMetadataFlag(): this;
/**
* Grants permission to refresh an access token
*
* Access Level: Write
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_RefreshToken.html
*/
toRefreshToken(): this;
/**
* Grants permission to reset an existing metadata
*
* Access Level: Write
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_ResetMetadataFlag.html
*/
toResetMetadataFlag(): this;
/**
* Grants permission to start a codegen job
*
* Access Level: Write
*
* Possible conditions:
* - .ifAwsRequestTag()
* - .ifAwsTagKeys()
*
* Dependent actions:
* - amplify:GetApp
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_StartCodegenJob.html
*/
toStartCodegenJob(): this;
/**
* Grants permission to tag the resource with a tag key and value
*
* Access Level: Tagging
*
* Possible conditions:
* - .ifAwsTagKeys()
* - .ifAwsRequestTag()
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_TagResource.html
*/
toTagResource(): this;
/**
* Grants permission to untag a resource with a specified Amazon Resource Name (ARN)
*
* Access Level: Tagging
*
* Possible conditions:
* - .ifAwsTagKeys()
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_UntagResource.html
*/
toUntagResource(): this;
/**
* Grants permission to update a component
*
* Access Level: Write
*
* Dependent actions:
* - amplify:GetApp
* - amplifyuibuilder:TagResource
* - amplifyuibuilder:UntagResource
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_UpdateComponent.html
*/
toUpdateComponent(): this;
/**
* Grants permission to update a form
*
* Access Level: Write
*
* Dependent actions:
* - amplify:GetApp
* - amplifyuibuilder:GetForm
* - amplifyuibuilder:TagResource
* - amplifyuibuilder:UntagResource
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_UpdateForm.html
*/
toUpdateForm(): this;
/**
* Grants permission to update a theme
*
* Access Level: Write
*
* Dependent actions:
* - amplify:GetApp
* - amplifyuibuilder:GetTheme
* - amplifyuibuilder:TagResource
* - amplifyuibuilder:UntagResource
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_UpdateTheme.html
*/
toUpdateTheme(): this;
protected accessLevelList: AccessLevelList;
/**
* Adds a resource of type CodegenJobResource to the statement
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_CodegenJob.html
*
* @param appId - Identifier for the appId.
* @param environmentName - Identifier for the environmentName.
* @param id - Identifier for the id.
* @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:
* - .ifCodegenJobResourceAppId()
* - .ifCodegenJobResourceEnvironmentName()
* - .ifCodegenJobResourceId()
* - .ifAwsResourceTag()
*/
onCodegenJobResource(appId: string, environmentName: string, id: string, account?: string, region?: string, partition?: string): this;
/**
* Adds a resource of type ComponentResource to the statement
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_Component.html
*
* @param appId - Identifier for the appId.
* @param environmentName - Identifier for the environmentName.
* @param id - Identifier for the id.
* @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:
* - .ifComponentResourceAppId()
* - .ifComponentResourceEnvironmentName()
* - .ifComponentResourceId()
* - .ifAwsResourceTag()
*/
onComponentResource(appId: string, environmentName: string, id: string, account?: string, region?: string, partition?: string): this;
/**
* Adds a resource of type FormResource to the statement
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_Form.html
*
* @param appId - Identifier for the appId.
* @param environmentName - Identifier for the environmentName.
* @param id - Identifier for the id.
* @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:
* - .ifFormResourceAppId()
* - .ifFormResourceEnvironmentName()
* - .ifFormResourceId()
* - .ifAwsResourceTag()
*/
onFormResource(appId: string, environmentName: string, id: string, account?: string, region?: string, partition?: string): this;
/**
* Adds a resource of type ThemeResource to the statement
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_Theme.html
*
* @param appId - Identifier for the appId.
* @param environmentName - Identifier for the environmentName.
* @param id - Identifier for the id.
* @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:
* - .ifThemeResourceAppId()
* - .ifThemeResourceEnvironmentName()
* - .ifThemeResourceId()
* - .ifAwsResourceTag()
*/
onThemeResource(appId: string, environmentName: string, id: string, account?: string, region?: string, partition?: string): this;
/**
* Filters access by the app ID
*
* https://docs.aws.amazon.com/amplify/latest/APIReference/API_App.html
*
* Applies to resource types:
* - CodegenJobResource
*
* @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`
*/
ifCodegenJobResourceAppId(value: string | string[], operator?: Operator | string): this;
/**
* Filters access by the backend environment name
*
* https://docs.aws.amazon.com/amplify/latest/APIReference/API_BackendEnvironment.html
*
* Applies to resource types:
* - CodegenJobResource
*
* @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`
*/
ifCodegenJobResourceEnvironmentName(value: string | string[], operator?: Operator | string): this;
/**
* Filters access by the codegen job ID
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_CodegenJob.html
*
* Applies to resource types:
* - CodegenJobResource
*
* @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`
*/
ifCodegenJobResourceId(value: string | string[], operator?: Operator | string): this;
/**
* Filters access by the app ID
*
* https://docs.aws.amazon.com/amplify/latest/APIReference/API_App.html
*
* Applies to resource types:
* - ComponentResource
*
* @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`
*/
ifComponentResourceAppId(value: string | string[], operator?: Operator | string): this;
/**
* Filters access by the backend environment name
*
* https://docs.aws.amazon.com/amplify/latest/APIReference/API_BackendEnvironment.html
*
* Applies to resource types:
* - ComponentResource
*
* @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`
*/
ifComponentResourceEnvironmentName(value: string | string[], operator?: Operator | string): this;
/**
* Filters access by the component ID
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_Component.html
*
* Applies to resource types:
* - ComponentResource
*
* @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`
*/
ifComponentResourceId(value: string | string[], operator?: Operator | string): this;
/**
* Filters access by the app ID
*
* https://docs.aws.amazon.com/amplify/latest/APIReference/API_App.html
*
* Applies to resource types:
* - FormResource
*
* @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`
*/
ifFormResourceAppId(value: string | string[], operator?: Operator | string): this;
/**
* Filters access by the backend environment name
*
* https://docs.aws.amazon.com/amplify/latest/APIReference/API_BackendEnvironment.html
*
* Applies to resource types:
* - FormResource
*
* @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`
*/
ifFormResourceEnvironmentName(value: string | string[], operator?: Operator | string): this;
/**
* Filters access by the form ID
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_Form.html
*
* Applies to resource types:
* - FormResource
*
* @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`
*/
ifFormResourceId(value: string | string[], operator?: Operator | string): this;
/**
* Filters access by the app ID
*
* https://docs.aws.amazon.com/amplify/latest/APIReference/API_App.html
*
* Applies to resource types:
* - ThemeResource
*
* @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`
*/
ifThemeResourceAppId(value: string | string[], operator?: Operator | string): this;
/**
* Filters access by the backend environment name
*
* https://docs.aws.amazon.com/amplify/latest/APIReference/API_BackendEnvironment.html
*
* Applies to resource types:
* - ThemeResource
*
* @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`
*/
ifThemeResourceEnvironmentName(value: string | string[], operator?: Operator | string): this;
/**
* Filters access by the theme ID
*
* https://docs.aws.amazon.com/amplifyuibuilder/latest/APIReference/API_Theme.html
*
* Applies to resource types:
* - ThemeResource
*
* @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`
*/
ifThemeResourceId(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:
* - .toCreateComponent()
* - .toCreateForm()
* - .toCreateTheme()
* - .toStartCodegenJob()
* - .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:
* - CodegenJobResource
* - ComponentResource
* - FormResource
* - ThemeResource
*
* @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:
* - .toCreateComponent()
* - .toCreateForm()
* - .toCreateTheme()
* - .toStartCodegenJob()
* - .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 [amplifyuibuilder](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsamplifyuibuilder.html).
*
*/
constructor(props?: iam.PolicyStatementProps);
}