cdk-iam-floyd/lib/shared/policy-statement/6-arn-defaults.d.ts

AWS IAM policy statement generator with fluent interface for AWS CDK

import { PolicyStatementWithEffect } from './5-effect';
/**
 * Adds "arn defaults" functionality to the Policy Statement
 */
export declare class PolicyStatementWithArnDefaults extends PolicyStatementWithEffect {
    /**
     * The default partition for ARNs (such as one of [`aws`, `aws-us-gov`,
     * `aws-cn`]). Defaults to `aws`.
     */
    protected defaultPartition: string;
    /**
     * The default region for ARNs (such as `us-east-1`, `eu-central-1`,
     * `ap-east-1`, ...). Defaults to `*`.
     */
    protected defaultRegion: string;
    /**
     * The default account for ARNs. Defaults to `*`.
     */
    protected defaultAccount: string;
    /**
     * Sets the default partition, region and account for ARNs of this statement
     *
     * @param partition Default partition for ARNs, e.g. `aws`, `aws-us-gov`, `aws-cn`
     * @param region Default region for ARNs, e.g. `us-east-1`, `eu-central-1`, `ap-east-1`
     * @param account Default account ID for ARN, e.g. `123456789012`
     */
    in(account: string, region?: string, partition?: string): this;
    /**
     * Sets the default partition for ARNs of this statement
     * @param partition Default partition for ARNs, e.g. `aws`, `aws-us-gov`, `aws-cn`
     * @returns this
     */
    inPartition(partition: string): this;
    /**
     * Sets the default region for ARNs of this statement
     * @param region Default region for ARNs, e.g. `us-east-1`, `eu-central-1`, `ap-east-1`
     * @returns this
     */
    inRegion(region: string): this;
    /**
     * Sets the default account for ARNs of this statement
     * @param account Default account ID for ARN, e.g. `123456789012`
     * @returns this
     */
    inAccount(account: string): this;
}