cdk-iam-floyd/lib/generated/policy-statements/opensearchingestion.d.ts

AWS IAM policy statement generator with fluent interface for AWS CDK

import { AccessLevelList } from '../../shared/access-level';
import { PolicyStatement, Operator } from '../../shared';
import { aws_iam as iam } from "aws-cdk-lib";
/**
 * Statement provider for service [osis](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonopensearchingestion.html).
 *
 * @param sid [SID](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_sid.html) of the statement
 */
export declare class Osis extends PolicyStatement {
    servicePrefix: string;
    /**
     * Grants permission to create an OpenSearch Ingestion pipeline
     *
     * Access Level: Write
     *
     * Possible conditions:
     * - .ifAwsTagKeys()
     * - .ifAwsRequestTag()
     *
     * Dependent actions:
     * - iam:CreateServiceLinkedRole
     * - iam:PassRole
     * - kms:DescribeKey
     * - kms:GenerateDataKeyWithoutPlaintext
     * - logs:CreateLogDelivery
     *
     * https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_CreatePipeline.html
     */
    toCreatePipeline(): this;
    /**
     * Grants permission to create an OpenSearch Ingestion pipeline endpoint
     *
     * Access Level: Write
     *
     * Possible conditions:
     * - .ifAwsTagKeys()
     * - .ifAwsRequestTag()
     *
     * Dependent actions:
     * - iam:CreateServiceLinkedRole
     *
     * https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_CreatePipelineEndpoint.html
     */
    toCreatePipelineEndpoint(): this;
    /**
     * Grants permission to delete an OpenSearch Ingestion pipeline
     *
     * Access Level: Write
     *
     * Dependent actions:
     * - logs:DeleteLogDelivery
     * - logs:GetLogDelivery
     * - logs:ListLogDeliveries
     *
     * https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_DeletePipeline.html
     */
    toDeletePipeline(): this;
    /**
     * Grants permission to delete an OpenSearch Ingestion pipeline endpoint in the current account
     *
     * Access Level: Write
     *
     * https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_DeletePipelineEndpoint.html
     */
    toDeletePipelineEndpoint(): this;
    /**
     * Grants permission to delete a resource policy for an OpenSearch Ingestion resource
     *
     * Access Level: Write
     *
     * https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_DeleteResourcePolicy.html
     */
    toDeleteResourcePolicy(): this;
    /**
     * Grants permission to retrieve configuration information for an OpenSearch Ingestion pipeline
     *
     * Access Level: Read
     *
     * https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_GetPipeline.html
     */
    toGetPipeline(): this;
    /**
     * Grants permission to get the contents of an OpenSearch Ingestion pipeline blueprint
     *
     * Access Level: Read
     *
     * https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_GetPipelineBlueprint.html
     */
    toGetPipelineBlueprint(): this;
    /**
     * Grants permission to get granular information about the status of an OpenSearch Ingestion pipeline
     *
     * Access Level: Read
     *
     * https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_GetPipelineChangeProgress.html
     */
    toGetPipelineChangeProgress(): this;
    /**
     * Grants permission to get a resource policy for an OpenSearch Ingestion resource
     *
     * Access Level: Read
     *
     * https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_GetResourcePolicy.html
     */
    toGetResourcePolicy(): this;
    /**
     * Grants permission to ingest data through an OpenSearch Ingestion pipeline
     *
     * Access Level: Write
     *
     * https://docs.aws.amazon.com/opensearch-service/latest/developerguide/configure-client.html
     */
    toIngest(): this;
    /**
     * Grants permission to list the names of available blueprints for an OpenSearch Ingestion pipeline configuration
     *
     * Access Level: List
     *
     * https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_ListPipelineBlueprints.html
     */
    toListPipelineBlueprints(): this;
    /**
     * Grants permission to list OpenSearch Ingestion pipeline endpoint connections to pipelines in the current account
     *
     * Access Level: List
     *
     * https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_ListPipelineEndpointConnections.html
     */
    toListPipelineEndpointConnections(): this;
    /**
     * Grants permission to list OpenSearch Ingestion pipeline endpoints in the current account
     *
     * Access Level: List
     *
     * https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_ListPipelineEndpoints.html
     */
    toListPipelineEndpoints(): this;
    /**
     * Grants permission to list basic configuration for each OpenSearch Ingestion pipeline in the current account and Region
     *
     * Access Level: List
     *
     * https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_ListPipelines.html
     */
    toListPipelines(): this;
    /**
     * Grants permission to list all resource tags associated with an OpenSearch Ingestion pipeline
     *
     * Access Level: Read
     *
     * https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_ListTagsForResource.html
     */
    toListTagsForResource(): this;
    /**
     * Grants permission to put a resource policy for an OpenSearch Ingestion resource
     *
     * Access Level: Write
     *
     * https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_PutResourcePolicy.html
     */
    toPutResourcePolicy(): this;
    /**
     * Grants permission to revoke an OpenSearch Ingestion pipeline endpoint connection from a pipeline in the current account
     *
     * Access Level: Write
     *
     * https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_RevokePipelineEndpointConnections.html
     */
    toRevokePipelineEndpointConnections(): this;
    /**
     * Grants permission to start an OpenSearch Ingestion pipeline
     *
     * Access Level: Write
     *
     * https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_StartPipeline.html
     */
    toStartPipeline(): this;
    /**
     * Grants permission to stop an OpenSearch Ingestion pipeline
     *
     * Access Level: Write
     *
     * https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_StopPipeline.html
     */
    toStopPipeline(): this;
    /**
     * Grants permission to attach resource tags to an OpenSearch Ingestion pipeline
     *
     * Access Level: Tagging
     *
     * Possible conditions:
     * - .ifAwsRequestTag()
     * - .ifAwsTagKeys()
     *
     * https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_TagResource.html
     */
    toTagResource(): this;
    /**
     * Grants permission to remove resource tags from an OpenSearch Ingestion Service pipeline
     *
     * Access Level: Tagging
     *
     * Possible conditions:
     * - .ifAwsTagKeys()
     *
     * https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_UntagResource.html
     */
    toUntagResource(): this;
    /**
     * Grants permission to modify the configuration of an OpenSearch Ingestion pipeline
     *
     * Access Level: Write
     *
     * Dependent actions:
     * - iam:PassRole
     * - kms:DescribeKey
     * - kms:GenerateDataKeyWithoutPlaintext
     * - logs:GetLogDelivery
     * - logs:ListLogDeliveries
     * - logs:UpdateLogDelivery
     *
     * https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_UpdatePipeline.html
     */
    toUpdatePipeline(): this;
    /**
     * Grants permission to validate the configuration of an OpenSearch Ingestion pipeline
     *
     * Access Level: Read
     *
     * https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_ValidatePipeline.html
     */
    toValidatePipeline(): this;
    protected accessLevelList: AccessLevelList;
    /**
     * Adds a resource of type pipeline to the statement
     *
     * https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_Pipeline.html
     *
     * @param pipelineName - Identifier for the pipelineName.
     * @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()
     */
    onPipeline(pipelineName: string, account?: string, region?: string, partition?: string): this;
    /**
     * Adds a resource of type pipeline-endpoint to the statement
     *
     * https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_PipelineEndpoint.html
     *
     * @param endpointId - Identifier for the endpointId.
     * @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()
     */
    onPipelineEndpoint(endpointId: string, account?: string, region?: string, partition?: string): this;
    /**
     * Adds a resource of type pipeline-blueprint to the statement
     *
     * https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_PipelineBlueprint.html
     *
     * @param blueprintName - Identifier for the blueprintName.
     * @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.
     */
    onPipelineBlueprint(blueprintName: 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:
     * - .toCreatePipeline()
     * - .toCreatePipelineEndpoint()
     * - .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:
     * - pipeline
     * - pipeline-endpoint
     *
     * @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:
     * - .toCreatePipeline()
     * - .toCreatePipelineEndpoint()
     * - .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 [osis](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonopensearchingestion.html).
     *
     */
    constructor(props?: iam.PolicyStatementProps);
}