@gradientedge/cdk-utils 8.118.0 → 8.119.0

package/dist/src/lib/services/aws/identity-access-management/main.d.ts

@@ -1,20 +1,19 @@
-import * as cdk from 'aws-cdk-lib';
-import * as ecs from 'aws-cdk-lib/aws-ecs';
-import * as events from 'aws-cdk-lib/aws-events';
-import * as iam from 'aws-cdk-lib/aws-iam';
-import * as logs from 'aws-cdk-lib/aws-logs';
-import * as s3 from 'aws-cdk-lib/aws-s3';
-import * as sqs from 'aws-cdk-lib/aws-sqs';
+import { ICluster, ITaskDefinition } from 'aws-cdk-lib/aws-ecs';
+import { IRule } from 'aws-cdk-lib/aws-events';
+import { CfnRole, PolicyDocument, PolicyStatement, Role, ServicePrincipal } from 'aws-cdk-lib/aws-iam';
+import { CfnLogGroup } from 'aws-cdk-lib/aws-logs';
+import { IBucket } from 'aws-cdk-lib/aws-s3';
+import { Queue } from 'aws-cdk-lib/aws-sqs';
 import { CommonConstruct } from '../../../common';
 /**
- * @classdesc Provides operations on AWS IAM.
+ * @classdesc Provides operations on AWS
  * - A new instance of this class is injected into {@link CommonConstruct} constructor.
  * - If a custom construct extends {@link CommonConstruct}, an instance is available within the context.
  * @example
  * import { CommonConstruct } from '@gradientedge/cdk-utils'
  *
  * class CustomConstruct extends CommonConstruct {
- *   constructor(parent: cdk.Construct, id: string, props: common.CommonStackProps) {
+ *   constructor(parent: Construct, id: string, props: common.CommonStackProps) {
  *     super(parent, id, props)
  *     this.props = props
  *     this.iamManager.createRoleForEcsEvent('MyEcsRole', this, cluster, task)
@@ -28,162 +27,162 @@ export declare class IamManager {
      * @param scope scope in which this resource is defined
      * @param resourceArns list of ARNs to allow access to
      */
-    statementForReadSecrets(scope: CommonConstruct, resourceArns?: string[]): cdk.aws_iam.PolicyStatement;
+    statementForReadSecrets(scope: CommonConstruct, resourceArns?: string[]): PolicyStatement;
     /**
      * @summary Method to create iam statement to put events
      * @param resourceArns list of ARNs to allow access to
      */
-    statementForPutEvents(resourceArns?: string[]): cdk.aws_iam.PolicyStatement;
+    statementForPutEvents(resourceArns?: string[]): PolicyStatement;
     /**
-     * @summary Method to create iam statement to start stepfunction execution
+     * @summary Method to create iam statement to start step function execution
      * @param resourceArns list of ARNs to allow access to
      */
-    statementForStartExecution(resourceArns?: string[]): cdk.aws_iam.PolicyStatement;
+    statementForStartExecution(resourceArns?: string[]): PolicyStatement;
     /**
      * @summary Method to create iam statement to poll queue
      * @param resourceArns list of ARNs to allow access to
      */
-    statementForPollQueue(resourceArns?: string[]): cdk.aws_iam.PolicyStatement;
+    statementForPollQueue(resourceArns?: string[]): PolicyStatement;
     /**
      * @summary Method to create iam statement to invoke lambda function
      * @param resourceArns list of ARNs to allow access to
      */
-    statementForInvokeLambda(resourceArns?: string[]): cdk.aws_iam.PolicyStatement;
+    statementForInvokeLambda(resourceArns?: string[]): PolicyStatement;
     /**
      * @summary Method to create iam statement to read app config
      * @param resourceArns list of ARNs to allow access to
      */
-    statementForReadAnyAppConfig(resourceArns?: string[]): cdk.aws_iam.PolicyStatement;
+    statementForReadAnyAppConfig(resourceArns?: string[]): PolicyStatement;
     /**
      * @summary Method to create iam statement to access app config
      * @param resourceArns list of ARNs to allow access to
      */
-    statementForAppConfigExecution(resourceArns?: string[]): cdk.aws_iam.PolicyStatement;
+    statementForAppConfigExecution(resourceArns?: string[]): PolicyStatement;
     /**
      * @summary Method to create iam statement to put xray telemetry
      * @param resourceArns list of ARNs to allow access to
      */
-    statementForPutXrayTelemetry(resourceArns?: string[]): cdk.aws_iam.PolicyStatement;
+    statementForPutXrayTelemetry(resourceArns?: string[]): PolicyStatement;
     /**
      * @summary Method to create iam statement to decrypt kms
      * @param resourceArns list of ARNs to allow access to
      */
-    statementForDecryptKms(resourceArns?: string[]): cdk.aws_iam.PolicyStatement;
+    statementForDecryptKms(resourceArns?: string[]): PolicyStatement;
     /**
      * @summary Method to create iam statement to list s3 buckets
      * @param scope scope in which this resource is defined
      * @param bucket
      */
-    statementForListBucket(scope: CommonConstruct, bucket: s3.IBucket): cdk.aws_iam.PolicyStatement;
+    statementForListBucket(scope: CommonConstruct, bucket: IBucket): PolicyStatement;
     /**
      * @summary Method to create iam statement to list all s3 buckets
      * @param resourceArns list of ARNs to allow access to
      */
-    statementForListAllMyBuckets(resourceArns?: string[]): cdk.aws_iam.PolicyStatement;
+    statementForListAllMyBuckets(resourceArns?: string[]): PolicyStatement;
     /**
      * @summary Method to create iam statement to get s3 objects in buckets
      * @param scope scope in which this resource is defined
      * @param bucket
      * @param resourceArns list of ARNs to allow access to
      */
-    statementForGetAnyS3Objects(scope: CommonConstruct, bucket: s3.IBucket, resourceArns?: string[]): cdk.aws_iam.PolicyStatement;
+    statementForGetAnyS3Objects(scope: CommonConstruct, bucket: IBucket, resourceArns?: string[]): PolicyStatement;
     /**
      * @summary Method to create iam statement to delete s3 objects in buckets
      * @param scope scope in which this resource is defined
      * @param bucket
      * @param resourceArns list of ARNs to allow access to
      */
-    statementForDeleteAnyS3Objects(scope: CommonConstruct, bucket: s3.IBucket, resourceArns?: string[]): cdk.aws_iam.PolicyStatement;
+    statementForDeleteAnyS3Objects(scope: CommonConstruct, bucket: IBucket, resourceArns?: string[]): PolicyStatement;
     /**
      * @summary Method to create iam statement to write s3 objects in buckets
      * @param scope scope in which this resource is defined
      * @param bucket
      * @param resourceArns list of ARNs to allow access to
      */
-    statementForPutAnyS3Objects(scope: CommonConstruct, bucket: s3.IBucket, resourceArns?: string[]): cdk.aws_iam.PolicyStatement;
+    statementForPutAnyS3Objects(scope: CommonConstruct, bucket: IBucket, resourceArns?: string[]): PolicyStatement;
     /**
      * @summary Method to create iam statement to pass iam role
      * @param resourceArns list of ARNs to allow access to
      */
-    statementForPassRole(resourceArns?: string[]): cdk.aws_iam.PolicyStatement;
+    statementForPassRole(resourceArns?: string[]): PolicyStatement;
     /**
      * @summary Method to create iam statement to invalidate cloudfront cache
      * @param resourceArns list of ARNs to allow access to
      */
-    statementForCloudfrontInvalidation(resourceArns?: string[]): cdk.aws_iam.PolicyStatement;
+    statementForCloudfrontInvalidation(resourceArns?: string[]): PolicyStatement;
     /**
      * @summary Method to create iam statement to access efs
      * @param resourceArns list of ARNs to allow access to
      */
-    statementForWriteEfs(resourceArns?: string[]): cdk.aws_iam.PolicyStatement;
+    statementForWriteEfs(resourceArns?: string[]): PolicyStatement;
     /**
      * @summary Method to create iam policy to invalidate cloudfront cache
      * @param resourceArns list of ARNs to allow access to
      */
-    policyForCloudfrontInvalidation(resourceArns?: string[]): cdk.aws_iam.PolicyDocument;
+    policyForCloudfrontInvalidation(resourceArns?: string[]): PolicyDocument;
     /**
      * @summary Method to create iam role to invalidate cloudfront cache
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
      */
-    roleForCloudfrontInvalidation(id: string, scope: CommonConstruct): cdk.aws_iam.Role;
+    roleForCloudfrontInvalidation(id: string, scope: CommonConstruct): Role;
     /**
      * @summary Method to create iam statement to assume iam role
      * @param scope scope in which this resource is defined
      * @param servicePrincipals
      */
-    statementForAssumeRole(scope: CommonConstruct, servicePrincipals: iam.ServicePrincipal[]): cdk.aws_iam.PolicyStatement;
+    statementForAssumeRole(scope: CommonConstruct, servicePrincipals: ServicePrincipal[]): PolicyStatement;
     /**
      * @summary Method to create iam statement to pass ecs role
      * @param resourceArns list of ARNs to allow access to
      */
-    statementForEcsPassRole(resourceArns?: string[]): cdk.aws_iam.PolicyStatement;
+    statementForEcsPassRole(resourceArns?: string[]): PolicyStatement;
     /**
      * @summary Method to create iam statement to run ecs task
      * @param scope scope in which this resource is defined
      * @param cluster
      * @param task
      */
-    statementForRunEcsTask(scope: CommonConstruct, cluster: ecs.ICluster, task: ecs.ITaskDefinition): cdk.aws_iam.PolicyStatement;
+    statementForRunEcsTask(scope: CommonConstruct, cluster: ICluster, task: ITaskDefinition): PolicyStatement;
     /**
      * @summary Method to create iam statement to create log stream
      * @param scope scope in which this resource is defined
      * @param logGroup
      */
-    statementForCreateLogStream(scope: CommonConstruct, logGroup: logs.CfnLogGroup): cdk.aws_iam.PolicyStatement;
+    statementForCreateLogStream(scope: CommonConstruct, logGroup: CfnLogGroup): PolicyStatement;
     /**
      * @summary Method to create iam statement to create any log stream
      * @param resourceArns list of ARNs to allow access to
      */
-    statementForCreateAnyLogStream(resourceArns?: string[]): cdk.aws_iam.PolicyStatement;
+    statementForCreateAnyLogStream(resourceArns?: string[]): PolicyStatement;
     /**
      * @summary Method to create iam statement to write log events
      * @param scope scope in which this resource is defined
      * @param logGroup
      */
-    statementForPutLogEvent(scope: CommonConstruct, logGroup: logs.CfnLogGroup): cdk.aws_iam.PolicyStatement;
+    statementForPutLogEvent(scope: CommonConstruct, logGroup: CfnLogGroup): PolicyStatement;
     /**
      * @summary Method to create iam statement to write any log events
      * @param resourceArns list of ARNs to allow access to
      */
-    statementForPutAnyLogEvent(resourceArns?: string[]): cdk.aws_iam.PolicyStatement;
+    statementForPutAnyLogEvent(resourceArns?: string[]): PolicyStatement;
     /**
      * @summary Method to create iam statement to read items from dynamodb table
      * @param resourceArns list of ARNs to allow access to
      */
-    statementForReadTableItems(resourceArns?: string[]): cdk.aws_iam.PolicyStatement;
+    statementForReadTableItems(resourceArns?: string[]): PolicyStatement;
     /**
      * @summary Method to create iam statement to write items from dynamodb table
      * @param resourceArns list of ARNs to allow access to
      */
-    statementForWriteTableItems(resourceArns?: string[]): cdk.aws_iam.PolicyStatement;
+    statementForWriteTableItems(resourceArns?: string[]): PolicyStatement;
     /**
      * @summary Method to create iam statement for cloud trail
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
      * @param logGroup
      */
-    createRoleForCloudTrail(id: string, scope: CommonConstruct, logGroup: logs.CfnLogGroup): cdk.aws_iam.CfnRole;
+    createRoleForCloudTrail(id: string, scope: CommonConstruct, logGroup: CfnLogGroup): CfnRole;
     /**
      * @summary Method to create iam statement for ecs event
      * @param id scoped id of the resource
@@ -191,38 +190,38 @@ export declare class IamManager {
      * @param cluster
      * @param task
      */
-    createRoleForEcsEvent(id: string, scope: CommonConstruct, cluster: ecs.ICluster, task: ecs.ITaskDefinition): cdk.aws_iam.Role;
+    createRoleForEcsEvent(id: string, scope: CommonConstruct, cluster: ICluster, task: ITaskDefinition): Role;
     /**
      * @summary Method to create iam statement for ecs execution
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
      * @param policy
      */
-    createRoleForEcsExecution(id: string, scope: CommonConstruct, policy: iam.PolicyDocument): cdk.aws_iam.Role;
+    createRoleForEcsExecution(id: string, scope: CommonConstruct, policy: PolicyDocument): Role;
     /**
      * @summary Method to create iam statement for lambda execution
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
      * @param policy
-     * @param servicePrinicpal
+     * @param servicePrincipal
      */
-    createRoleForLambda(id: string, scope: CommonConstruct, policy: iam.PolicyDocument, servicePrinicpal?: iam.ServicePrincipal): cdk.aws_iam.Role;
+    createRoleForLambda(id: string, scope: CommonConstruct, policy: PolicyDocument, servicePrincipal?: ServicePrincipal): Role;
     /**
      * @summary Method to create iam statement for appconfig secrets manager integration
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
      * @param policy
-     * @param servicePrinicpal
+     * @param servicePrincipal
      */
-    createRoleForAppConfigSecrets(id: string, scope: CommonConstruct, policy: iam.PolicyDocument, servicePrinicpal?: iam.ServicePrincipal): cdk.aws_iam.Role;
+    createRoleForAppConfigSecrets(id: string, scope: CommonConstruct, policy: PolicyDocument, servicePrincipal?: ServicePrincipal): Role;
     /**
      * @summary Method to create iam statement for step function execution
      * @param id scoped id of the resource
      * @param scope scope in which this resource is defined
      * @param policy
-     * @param servicePrinicpal
+     * @param servicePrincipal
      */
-    createRoleForStepFunction(id: string, scope: CommonConstruct, policy: iam.PolicyDocument, servicePrinicpal?: iam.ServicePrincipal): cdk.aws_iam.Role;
+    createRoleForStepFunction(id: string, scope: CommonConstruct, policy: PolicyDocument, servicePrincipal?: ServicePrincipal): Role;
     /**
      * @summary Method to create iam statement for sqs to step function pipe
      * @param id scoped id of the resource
@@ -230,7 +229,7 @@ export declare class IamManager {
      * @param queueArn the arn of the sqs queue
      * @param stepFunctionArn the arn of the step function
      */
-    createRoleForSqsToSfnPipe(id: string, scope: CommonConstruct, queueArn: string, stepFunctionArn: string): cdk.aws_iam.Role;
+    createRoleForSqsToSfnPipe(id: string, scope: CommonConstruct, queueArn: string, stepFunctionArn: string): Role;
     /**
      * @summary Method to create iam policy for sqs
      * @param id scoped id of the resource
@@ -239,5 +238,5 @@ export declare class IamManager {
      * @param eventBridgeRule
      * @param servicePrincipals
      */
-    createPolicyForSqsEvent(id: string, scope: CommonConstruct, sqsQueue: sqs.Queue, eventBridgeRule: events.IRule, servicePrincipals?: iam.ServicePrincipal[]): cdk.aws_iam.PolicyDocument;
+    createPolicyForSqsEvent(id: string, scope: CommonConstruct, sqsQueue: Queue, eventBridgeRule: IRule, servicePrincipals?: ServicePrincipal[]): PolicyDocument;
 }