cdk-iam-floyd/lib/generated/policy-statements/apigateway.js

AWS IAM policy statement generator with fluent interface for AWS CDK

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.ExecuteApi = void 0;
const shared_1 = require("../../shared");
/**
 * Statement provider for service [execute-api](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonapigateway.html).
 *
 * @param sid [SID](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_sid.html) of the statement
 */
class ExecuteApi extends shared_1.PolicyStatement {
    /**
     * Used to invalidate API cache upon a client request
     *
     * Access Level: Write
     *
     * https://docs.aws.amazon.com/apigateway/api-reference/api-gateway-caching.html
     */
    toInvalidateCache() {
        return this.to('InvalidateCache');
    }
    /**
     * Used to invoke an API upon a client request
     *
     * Access Level: Write
     *
     * https://docs.aws.amazon.com/apigateway/api-reference/how-to-call-api.html
     */
    toInvoke() {
        return this.to('Invoke');
    }
    /**
     * ManageConnections controls access to the @connections API
     *
     * Access Level: Write
     *
     * https://docs.aws.amazon.com/apigateway/api-reference/apigateway-websocket-control-access-iam.html
     */
    toManageConnections() {
        return this.to('ManageConnections');
    }
    /**
     * Adds a resource of type execute-api-general to the statement
     *
     * https://docs.aws.amazon.com/apigateway/latest/developerguide/security_iam_service-with-iam.html
     *
     * @param apiId - Identifier for the apiId.
     * @param stage - Identifier for the stage.
     * @param method - Identifier for the method.
     * @param apiSpecificResourcePath - Identifier for the apiSpecificResourcePath.
     * @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:
     * - .ifViaDomainArn()
     */
    onExecuteApiGeneral(apiId, stage, method, apiSpecificResourcePath, account, region, partition) {
        return this.on(`arn:${partition ?? this.defaultPartition}:execute-api:${region ?? this.defaultRegion}:${account ?? this.defaultAccount}:${apiId}/${stage}/${method}/${apiSpecificResourcePath}`);
    }
    /**
     * Adds a resource of type execute-api-domain to the statement
     *
     * https://docs.aws.amazon.com/apigateway/latest/developerguide/security_iam_service-with-iam.html
     *
     * @param domainName - Identifier for the domainName.
     * @param domainIdentifier - Identifier for the domainIdentifier.
     * @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.
     */
    onExecuteApiDomain(domainName, domainIdentifier, account, region, partition) {
        return this.on(`arn:${partition ?? this.defaultPartition}:execute-api:${region ?? this.defaultRegion}:${account ?? this.defaultAccount}:/domainnames/${domainName}+${domainIdentifier}`);
    }
    /**
     * Filters access by the domain name ARN the API is called from
     *
     * https://docs.aws.amazon.com/apigateway/latest/developerguide/security_iam_service-with-iam.html
     *
     * Applies to resource types:
     * - execute-api-general
     *
     * @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`
     */
    ifViaDomainArn(value, operator) {
        return this.if(`viaDomainArn`, value, operator ?? 'StringLike');
    }
    /**
     * Statement provider for service [execute-api](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonapigateway.html).
     *
     */
    constructor(props) {
        super(props);
        this.servicePrefix = 'execute-api';
        this.accessLevelList = {
            Write: [
                'InvalidateCache',
                'Invoke',
                'ManageConnections'
            ]
        };
    }
}
exports.ExecuteApi = ExecuteApi;
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"apigateway.js","sourceRoot":"","sources":["apigateway.ts"],"names":[],"mappings":";;;AACA,yCAAyD;AAGzD;;;;GAIG;AACH,MAAa,UAAW,SAAQ,wBAAe;IAG7C;;;;;;OAMG;IACI,iBAAiB;QACtB,OAAO,IAAI,CAAC,EAAE,CAAC,iBAAiB,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;OAMG;IACI,QAAQ;QACb,OAAO,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC;IAC3B,CAAC;IAED;;;;;;OAMG;IACI,mBAAmB;QACxB,OAAO,IAAI,CAAC,EAAE,CAAC,mBAAmB,CAAC,CAAC;IACtC,CAAC;IAUD;;;;;;;;;;;;;;;OAeG;IACI,mBAAmB,CAAC,KAAa,EAAE,KAAa,EAAE,MAAc,EAAE,uBAA+B,EAAE,OAAgB,EAAE,MAAe,EAAE,SAAkB;QAC7J,OAAO,IAAI,CAAC,EAAE,CAAC,OAAQ,SAAS,IAAI,IAAI,CAAC,gBAAiB,gBAAiB,MAAM,IAAI,IAAI,CAAC,aAAc,IAAK,OAAO,IAAI,IAAI,CAAC,cAAe,IAAK,KAAM,IAAK,KAAM,IAAK,MAAO,IAAK,uBAAwB,EAAE,CAAC,CAAC;IACjN,CAAC;IAED;;;;;;;;;;OAUG;IACI,kBAAkB,CAAC,UAAkB,EAAE,gBAAwB,EAAE,OAAgB,EAAE,MAAe,EAAE,SAAkB;QAC3H,OAAO,IAAI,CAAC,EAAE,CAAC,OAAQ,SAAS,IAAI,IAAI,CAAC,gBAAiB,gBAAiB,MAAM,IAAI,IAAI,CAAC,aAAc,IAAK,OAAO,IAAI,IAAI,CAAC,cAAe,iBAAkB,UAAW,IAAK,gBAAiB,EAAE,CAAC,CAAC;IACrM,CAAC;IAED;;;;;;;;;;OAUG;IACI,cAAc,CAAC,KAAwB,EAAE,QAA4B;QAC1E,OAAO,IAAI,CAAC,EAAE,CAAC,cAAc,EAAE,KAAK,EAAE,QAAQ,IAAI,YAAY,CAAC,CAAC;IAClE,CAAC;IAED;;;OAGG;IACH,YAAY,KAAgC;QAC1C,KAAK,CAAC,KAAK,CAAC,CAAC;QAlGR,kBAAa,GAAG,aAAa,CAAC;QAmC3B,oBAAe,GAAoB;YAC3C,KAAK,EAAE;gBACL,iBAAiB;gBACjB,QAAQ;gBACR,mBAAmB;aACpB;SACF,CAAC;IA0DF,CAAC;CACF;AArGD,gCAqGC","sourcesContent":["import { AccessLevelList } from '../../shared/access-level';\nimport { PolicyStatement, Operator } from '../../shared';\nimport { aws_iam as iam } from \"aws-cdk-lib\";\n\n/**\n * Statement provider for service [execute-api](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonapigateway.html).\n *\n * @param sid [SID](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_sid.html) of the statement\n */\nexport class ExecuteApi extends PolicyStatement {\n  public servicePrefix = 'execute-api';\n\n  /**\n   * Used to invalidate API cache upon a client request\n   *\n   * Access Level: Write\n   *\n   * https://docs.aws.amazon.com/apigateway/api-reference/api-gateway-caching.html\n   */\n  public toInvalidateCache() {\n    return this.to('InvalidateCache');\n  }\n\n  /**\n   * Used to invoke an API upon a client request\n   *\n   * Access Level: Write\n   *\n   * https://docs.aws.amazon.com/apigateway/api-reference/how-to-call-api.html\n   */\n  public toInvoke() {\n    return this.to('Invoke');\n  }\n\n  /**\n   * ManageConnections controls access to the @connections API\n   *\n   * Access Level: Write\n   *\n   * https://docs.aws.amazon.com/apigateway/api-reference/apigateway-websocket-control-access-iam.html\n   */\n  public toManageConnections() {\n    return this.to('ManageConnections');\n  }\n\n  protected accessLevelList: AccessLevelList = {\n    Write: [\n      'InvalidateCache',\n      'Invoke',\n      'ManageConnections'\n    ]\n  };\n\n  /**\n   * Adds a resource of type execute-api-general to the statement\n   *\n   * https://docs.aws.amazon.com/apigateway/latest/developerguide/security_iam_service-with-iam.html\n   *\n   * @param apiId - Identifier for the apiId.\n   * @param stage - Identifier for the stage.\n   * @param method - Identifier for the method.\n   * @param apiSpecificResourcePath - Identifier for the apiSpecificResourcePath.\n   * @param account - Account of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's account.\n   * @param region - Region of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's region.\n   * @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.\n   *\n   * Possible conditions:\n   * - .ifViaDomainArn()\n   */\n  public onExecuteApiGeneral(apiId: string, stage: string, method: string, apiSpecificResourcePath: string, account?: string, region?: string, partition?: string) {\n    return this.on(`arn:${ partition ?? this.defaultPartition }:execute-api:${ region ?? this.defaultRegion }:${ account ?? this.defaultAccount }:${ apiId }/${ stage }/${ method }/${ apiSpecificResourcePath }`);\n  }\n\n  /**\n   * Adds a resource of type execute-api-domain to the statement\n   *\n   * https://docs.aws.amazon.com/apigateway/latest/developerguide/security_iam_service-with-iam.html\n   *\n   * @param domainName - Identifier for the domainName.\n   * @param domainIdentifier - Identifier for the domainIdentifier.\n   * @param account - Account of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's account.\n   * @param region - Region of the resource; defaults to `*`, unless using the CDK, where the default is the current Stack's region.\n   * @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.\n   */\n  public onExecuteApiDomain(domainName: string, domainIdentifier: string, account?: string, region?: string, partition?: string) {\n    return this.on(`arn:${ partition ?? this.defaultPartition }:execute-api:${ region ?? this.defaultRegion }:${ account ?? this.defaultAccount }:/domainnames/${ domainName }+${ domainIdentifier }`);\n  }\n\n  /**\n   * Filters access by the domain name ARN the API is called from\n   *\n   * https://docs.aws.amazon.com/apigateway/latest/developerguide/security_iam_service-with-iam.html\n   *\n   * Applies to resource types:\n   * - execute-api-general\n   *\n   * @param value The value(s) to check\n   * @param operator Works with [string operators](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_condition_operators.html#Conditions_String). **Default:** `StringLike`\n   */\n  public ifViaDomainArn(value: string | string[], operator?: Operator | string) {\n    return this.if(`viaDomainArn`, value, operator ?? 'StringLike');\n  }\n\n  /**\n   * Statement provider for service [execute-api](https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonapigateway.html).\n   *\n   */\n  constructor(props?: iam.PolicyStatementProps) {\n    super(props);\n  }\n}\n"]}