iam-floyd
Version:
AWS IAM policy statement generator with fluent interface
551 lines (550 loc) • 20.7 kB
TypeScript
import { AccessLevelList } from '../../shared/access-level';
import { PolicyStatement, Operator } from '../../shared';
/**
* Statement provider for service [iottwinmaker](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiottwinmaker.html).
*
* @param sid [SID](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_sid.html) of the statement
*/
export declare class Iottwinmaker extends PolicyStatement {
servicePrefix: string;
/**
* Statement provider for service [iottwinmaker](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiottwinmaker.html).
*
* @param sid [SID](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_sid.html) of the statement
*/
constructor(sid?: string);
/**
* Grants permission to set values for multiple time series properties
*
* Access Level: Write
*
* Dependent actions:
* - iottwinmaker:GetComponentType
* - iottwinmaker:GetEntity
* - iottwinmaker:GetWorkspace
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_BatchPutPropertyValues.html
*/
toBatchPutPropertyValues(): this;
/**
* Grants permission to cancel a metadata transfer job
*
* Access Level: Write
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_CancelMetadataTransferJob.html
*/
toCancelMetadataTransferJob(): this;
/**
* Grants permission to create a componentType
*
* Access Level: Write
*
* Possible conditions:
* - .ifAwsRequestTag()
* - .ifAwsTagKeys()
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_CreateComponentType.html
*/
toCreateComponentType(): this;
/**
* Grants permission to create an entity
*
* Access Level: Write
*
* Possible conditions:
* - .ifAwsRequestTag()
* - .ifAwsTagKeys()
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_CreateEntity.html
*/
toCreateEntity(): this;
/**
* Grants permission to create a metadata transfer job
*
* Access Level: Write
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_CreateMetadataTransferJob.html
*/
toCreateMetadataTransferJob(): this;
/**
* Grants permission to create a scene
*
* Access Level: Write
*
* Possible conditions:
* - .ifAwsRequestTag()
* - .ifAwsTagKeys()
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_CreateScene.html
*/
toCreateScene(): this;
/**
* Grants permission to create a sync job
*
* Access Level: Write
*
* Possible conditions:
* - .ifAwsRequestTag()
* - .ifAwsTagKeys()
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_CreateSyncJob.html
*/
toCreateSyncJob(): this;
/**
* Grants permission to create a workspace
*
* Access Level: Write
*
* Possible conditions:
* - .ifAwsRequestTag()
* - .ifAwsTagKeys()
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_CreateWorkspace.html
*/
toCreateWorkspace(): this;
/**
* Grants permission to delete a componentType
*
* Access Level: Write
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_DeleteComponentType.html
*/
toDeleteComponentType(): this;
/**
* Grants permission to delete an entity
*
* Access Level: Write
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_DeleteEntity.html
*/
toDeleteEntity(): this;
/**
* Grants permission to delete a scene
*
* Access Level: Write
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_DeleteScene.html
*/
toDeleteScene(): this;
/**
* Grants permission to delete a sync job
*
* Access Level: Write
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_DeleteSyncJob.html
*/
toDeleteSyncJob(): this;
/**
* Grants permission to delete a workspace
*
* Access Level: Write
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_DeleteWorkspace.html
*/
toDeleteWorkspace(): this;
/**
* Grants permission to execute query
*
* Access Level: Read
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_ExecuteQuery.html
*/
toExecuteQuery(): this;
/**
* Grants permission to get a componentType
*
* Access Level: Read
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_GetComponentType.html
*/
toGetComponentType(): this;
/**
* Grants permission to get an entity
*
* Access Level: Read
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_GetEntity.html
*/
toGetEntity(): this;
/**
* Grants permission to get a metadata transfer job
*
* Access Level: Read
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_GetMetadataTransferJob.html
*/
toGetMetadataTransferJob(): this;
/**
* Grants permission to get pricing plan
*
* Access Level: Read
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_GetPricingPlan.html
*/
toGetPricingPlan(): this;
/**
* Grants permission to retrieve the property values
*
* Access Level: Read
*
* Dependent actions:
* - iottwinmaker:GetComponentType
* - iottwinmaker:GetEntity
* - iottwinmaker:GetWorkspace
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_GetPropertyValue.html
*/
toGetPropertyValue(): this;
/**
* Grants permission to retrieve the time series value history
*
* Access Level: Read
*
* Dependent actions:
* - iottwinmaker:GetComponentType
* - iottwinmaker:GetEntity
* - iottwinmaker:GetWorkspace
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_GetPropertyValueHistory.html
*/
toGetPropertyValueHistory(): this;
/**
* Grants permission to get a scene
*
* Access Level: Read
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_GetScene.html
*/
toGetScene(): this;
/**
* Grants permission to get a sync job
*
* Access Level: Read
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_GetSyncJob.html
*/
toGetSyncJob(): this;
/**
* Grants permission to get a workspace
*
* Access Level: Read
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_GetWorkspace.html
*/
toGetWorkspace(): this;
/**
* Grants permission to list all componentTypes in a workspace
*
* Access Level: List
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_ListComponentTypes.html
*/
toListComponentTypes(): this;
/**
* Grants permission to list components attached to an entity
*
* Access Level: List
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_ListComponents.html
*/
toListComponents(): this;
/**
* Grants permission to list all entities in a workspace
*
* Access Level: List
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_ListEntities.html
*/
toListEntities(): this;
/**
* Grants permission to list all metadata transfer jobs
*
* Access Level: List
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_ListMetadataTransferJobs.html
*/
toListMetadataTransferJobs(): this;
/**
* Grants permission to list properties of an entity component
*
* Access Level: List
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_ListProperties.html
*/
toListProperties(): this;
/**
* Grants permission to list all scenes in a workspace
*
* Access Level: List
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_ListScenes.html
*/
toListScenes(): this;
/**
* Grants permission to list all sync jobs in a workspace
*
* Access Level: List
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_ListSyncJobs.html
*/
toListSyncJobs(): this;
/**
* Grants permission to list all sync resources for a sync job
*
* Access Level: List
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_ListSyncResources.html
*/
toListSyncResources(): this;
/**
* Grants permission to list all tags for a resource
*
* Access Level: List
*
* Possible conditions:
* - .ifAwsResourceTag()
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_ListTagsForResource.html
*/
toListTagsForResource(): this;
/**
* Grants permission to list all workspaces
*
* Access Level: List
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_ListWorkspaces.html
*/
toListWorkspaces(): this;
/**
* Grants permission to tag a resource
*
* Access Level: Tagging
*
* Possible conditions:
* - .ifAwsRequestTag()
* - .ifAwsTagKeys()
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_TagResource.html
*/
toTagResource(): this;
/**
* Grants permission to untag a resource
*
* Access Level: Tagging
*
* Possible conditions:
* - .ifAwsTagKeys()
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_UntagResource.html
*/
toUntagResource(): this;
/**
* Grants permission to update a componentType
*
* Access Level: Write
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_UpdateComponentType.html
*/
toUpdateComponentType(): this;
/**
* Grants permission to update an entity
*
* Access Level: Write
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_UpdateEntity.html
*/
toUpdateEntity(): this;
/**
* Grants permission to update pricing plan
*
* Access Level: Write
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_UpdatePricingPlan.html
*/
toUpdatePricingPlan(): this;
/**
* Grants permission to update a scene
*
* Access Level: Write
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_UpdateScene.html
*/
toUpdateScene(): this;
/**
* Grants permission to update a workspace
*
* Access Level: Write
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_UpdateWorkspace.html
*/
toUpdateWorkspace(): this;
protected accessLevelList: AccessLevelList;
/**
* Adds a resource of type workspace to the statement
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_CreateWorkspace.html
*
* @param workspaceId - Identifier for the workspaceId.
* @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()
*/
onWorkspace(workspaceId: string, account?: string, region?: string, partition?: string): this;
/**
* Adds a resource of type entity to the statement
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_CreateEntity.html
*
* @param workspaceId - Identifier for the workspaceId.
* @param entityId - Identifier for the entityId.
* @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()
*/
onEntity(workspaceId: string, entityId: string, account?: string, region?: string, partition?: string): this;
/**
* Adds a resource of type componentType to the statement
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_CreateComponentType.html
*
* @param workspaceId - Identifier for the workspaceId.
* @param componentTypeId - Identifier for the componentTypeId.
* @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()
*/
onComponentType(workspaceId: string, componentTypeId: string, account?: string, region?: string, partition?: string): this;
/**
* Adds a resource of type scene to the statement
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_CreateScene.html
*
* @param workspaceId - Identifier for the workspaceId.
* @param sceneId - Identifier for the sceneId.
* @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()
*/
onScene(workspaceId: string, sceneId: string, account?: string, region?: string, partition?: string): this;
/**
* Adds a resource of type syncJob to the statement
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_CreateSyncJob.html
*
* @param workspaceId - Identifier for the workspaceId.
* @param syncJobId - Identifier for the syncJobId.
* @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()
*/
onSyncJob(workspaceId: string, syncJobId: string, account?: string, region?: string, partition?: string): this;
/**
* Adds a resource of type metadataTransferJob to the statement
*
* https://docs.aws.amazon.com/iot-twinmaker/latest/apireference/API_CreateMetadataTransferJob.html
*
* @param metadataTransferJobId - Identifier for the metadataTransferJobId.
* @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.
*/
onMetadataTransferJob(metadataTransferJobId: 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:
* - .toCreateComponentType()
* - .toCreateEntity()
* - .toCreateScene()
* - .toCreateSyncJob()
* - .toCreateWorkspace()
* - .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 actions:
* - .toListTagsForResource()
*
* Applies to resource types:
* - workspace
* - entity
* - componentType
* - scene
* - syncJob
*
* @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 in the request
*
* https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_condition-keys.html#condition-keys-tagkeys
*
* Applies to actions:
* - .toCreateComponentType()
* - .toCreateEntity()
* - .toCreateScene()
* - .toCreateSyncJob()
* - .toCreateWorkspace()
* - .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 destination type of metadata transfer job
*
* https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiottwinmaker.html#awsiottwinmaker-policy-keys
*
* @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`
*/
ifDestinationType(value: string | string[], operator?: Operator | string): this;
/**
* Filters access by workspace linked to services
*
* https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiottwinmaker.html#awsiottwinmaker-policy-keys
*
* @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`
*/
ifLinkedServices(value: string | string[], operator?: Operator | string): this;
/**
* Filters access by source type of metadata transfer job
*
* https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiottwinmaker.html#awsiottwinmaker-policy-keys
*
* @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`
*/
ifSourceType(value: string | string[], operator?: Operator | string): this;
}