@cdklabs/cdk-enterprise-iac
Project description
CDK Enterprise IaC
Utilities for using CDK within enterprise constraints.
Install
Typescript
npm install @cdklabs/cdk-enterprise-iac
Python
pip install cdklabs.cdk-enterprise-iac
Who this project is for
Within large enterprises, builders can come up against enterprise imposed constraints when deploying on AWS.
This could be simple things such as "All IAM roles must have a specific Permissions Boundary attached".
This could also be more restrictive such as strict separation of duties, only allowing certain teams the ability to deploy specific AWS resources (e.g. Networking team can deploy VPCs, Subnets, and route tables. Security team can deploy IAM resources. Developers can deploy Compute. DBAs can deploy Databases, etc.)
Enterprises with very restrictive environments like these would benefit from taking a closer look at their policies to see how they can allow builders to safely deploy resources with less friction. However in many enterprises this is easier said than done, and builders are still expected to deliver.
This project is meant to reduce friction for builders working within these enterprise constraints while the enterprise determines what policies make the most sense for their organization, and is in no way prescriptive.
Usage
There are many tools available, all detailed in API.md.
A few examples of these tools below:
Adding permissions boundaries to all generated IAM roles
Example for AddPermissionBoundary in Typescript project.
# Example automatically generated from non-compiling source. May contain errors.
import aws_cdk as cdk
from ...lib.my_project_stack import MyStack
from aws_cdk import Aspects
from cdklabs.cdk_enterprise_iac import AddPermissionBoundary
app = cdk.App()
MyStack(app, "MyStack")
Aspects.of(app).add(
AddPermissionBoundary(
permissions_boundary_policy_name="MyPermissionBoundaryName",
instance_profile_prefix="MY_PREFIX_", # optional, Defaults to ''
policy_prefix="MY_POLICY_PREFIX_", # optional, Defaults to ''
role_prefix="MY_ROLE_PREFIX_"
))
Example for AddPermissionBoundary in Python project.
import aws_cdk as cdk
from cdklabs.cdk_enterprise_iac import AddPermissionBoundary
from test_py.test_py_stack import TestPyStack
app = cdk.App()
TestPyStack(app, "TestPyStack")
cdk.Aspects.of(app).add(AddPermissionBoundary(
permissions_boundary_policy_name="MyPermissionBoundaryName",
instance_profile_prefix="MY_PREFIX_", # optional, Defaults to ""
policy_prefix="MY_POLICY_PREFIX_", # optional, Defaults to ""
role_prefix="MY_ROLE_PREFIX_" # optional, Defaults to ""
))
app.synth()
Resource extraction
:warning: Resource extraction is in an experimental phase. Test and validate before using in production. Please open any issues found here.
In many enterprises, there are separate teams with different IAM permissions than developers deploying CDK applications.
For example there might be a networking team with permissions to deploy AWS::EC2::SecurityGroup and AWS::EC2::EIP, or a security team with permissions to deploy AWS::IAM::Role and AWS::IAM::Policy, but the developers deploying the CDK don't have those permissions.
When a developer doesn't have permissions to deploy necessary resources in their CDK application, writing good code becomes difficult to manage when a cdk deploy will quickly error due to not being able to deploy something like an AWS::IAM::Role which is foundational to any project deployed into AWS.
An enterprise should allow builders to deploy these resources via CDK for many reasons, and can use Permissions Boundaries to prevent privilege escalation. For enterprises that haven't yet utilized Permissions Boundaries, the ResourceExtractor can make it easier for builders to write good CDK while complying with enterprise policies.
Using the ResourceExtractor Aspect, developers can write their CDK code as though they had sufficient IAM permissions, but extract those resources into a separate stack for an external team to deploy on their behalf.
Take the following example stack:
# Example automatically generated from non-compiling source. May contain errors.
from aws_cdk import App, Aspects, RemovalPolicy, Stack
from aws_cdk.aws_lambda import Code, Function, Runtime
from aws_cdk.aws_s3 import Bucket
app = App()
app_stack = Stack(app, "MyAppStack")
func = Function(app_stack, "TestLambda",
code=Code.from_asset(path.join(__dirname, "lambda-handler")),
handler="index.handler",
runtime=Runtime.PYTHON_3_11
)
bucket = Bucket(app_stack, "TestBucket",
auto_delete_objects=True,
removal_policy=RemovalPolicy.DESTROY
)
bucket.grant_read_write(func)
app.synth()
The synthesized Cloudformation would include all AWS resources required, including resources a developer might not have permissions to deploy
The above example would include the following snippet in the synthesized Cloudformation
TestLambdaServiceRoleC28C2D9C:
Type: 'AWS::IAM::Role'
Properties:
AssumeRolePolicyDocument:
Statement:
- Action: 'sts:AssumeRole'
Effect: Allow
Principal:
Service: lambda.amazonaws.com
Version: 2012-10-17
# excluding remaining properties
TestLambda2F70C45E:
Type: 'AWS::Lambda::Function'
Properties:
Role: !GetAtt
- TestLambdaServiceRoleC28C2D9C
- Arn
# excluding remaining properties
While including bucket.grantReadWrite(func) in the CDK application ensures an IAM role with least privilege IAM policies for the application, the creation of IAM resources such as Roles and Policies may be restricted to a security team, resulting in the synthesized Cloudformation template not being deployable by a developer.
Using the ResourceExtractor, we can pull out an arbitrary list of Cloudformation resources that a developer doesn't have permissions to provision, and create a separate stack that can be sent to a security team.
# Example automatically generated from non-compiling source. May contain errors.
from aws_cdk import App, Aspects, RemovalPolicy, Stack
from aws_cdk.aws_lambda import Code, Function, Runtime
from aws_cdk.aws_s3 import Bucket
# Import ResourceExtractor
from cdklabs.cdk_enterprise_iac import ResourceExtractor
app = App()
app_stack = Stack(app, "MyAppStack")
# Set up a destination stack to extract resources to
extracted_stack = Stack(app, "ExtractedStack")
func = Function(app_stack, "TestLambda",
code=Code.from_asset(path.join(__dirname, "lambda-handler")),
handler="index.handler",
runtime=Runtime.PYTHON_3_11
)
bucket = Bucket(app_stack, "TestBucket",
auto_delete_objects=True,
removal_policy=RemovalPolicy.DESTROY
)
bucket.grant_read_write(func)
# Capture the output of app.synth()
synthed_app = app.synth()
# Apply the ResourceExtractor Aspect
Aspects.of(app).add(
ResourceExtractor(
# synthesized stacks to examine
stack_artifacts=synthed_app.stacks,
# Array of Cloudformation resources to extract
resource_types_to_extract=["AWS::IAM::Role", "AWS::IAM::Policy", "AWS::IAM::ManagedPolicy", "AWS::IAM::InstanceProfile"
],
# Destination stack for extracted resources
extract_destination_stack=extracted_stack
))
# Resynthing since ResourceExtractor has modified the app
app.synth(force=True)
In the example above, all resources are created in the appStack, and an empty extractedStack is also created.
We apply the ResourceExtractor Aspect, specifying the Cloudformation resource types the developer is unable to deploy due to insufficient IAM permissions.
Now when we list stacks in the CDK project, we can see an added stack
$ cdk ls
MyAppStack
ExtractedStack
Taking a look at these synthesized stacks, in the ExtractedStack we'll find:
Resources:
TestLambdaServiceRoleC28C2D9C:
Type: 'AWS::IAM::Role'
Properties:
AssumeRolePolicyDocument:
Statement:
- Action: 'sts:AssumeRole'
Effect: Allow
Principal:
Service: lambda.amazonaws.com
Version: 2012-10-17
# excluding remaining properties
Outputs:
ExportAppStackTestLambdaServiceRoleC28C2D9C:
Value:
'Fn::GetAtt':
- TestLambdaServiceRoleC28C2D9C
- Arn
Export:
Name: 'AppStack:TestLambdaServiceRoleC28C2D9C' # Exported name
And inside the synthesized MyAppStack template:
Resources:
TestLambda2F70C45E:
Type: 'AWS::Lambda::Function'
Properties:
Role: !ImportValue 'AppStack:TestLambdaServiceRoleC28C2D9C' # Using ImportValue instrinsic function to use pre-created IAM role
# excluding remaining properties
In this scenario, a developer is able to provide an external security team with sufficient IAM privileges to deploy the ExtractedStack.
Once deployed, a developer can run cdk deploy MyAppStack without errors due to insufficient IAM privileges
Value Sharing methods
When resources are extracted from a stack, there must be a method to reference the resources that have been extracted.
There are three methods (see ResourceExtractorShareMethod enum)
CFN_OUTPUTSSM_PARAMETERAPI_LOOKUP
CFN_OUTPUT
The default sharing method is CFN_OUTPUT, which uses Cloudformation Export/Import to Export values in the extracted stack (see Outputs), and use the Fn::ImportValue intrinsic function to reference those values.
This works fine, but some teams may prefer a looser coupling between the extracted stack deployed by an external team and the rest of the CDK infrastructure.
SSM_PARAMETER
In this method, the extracted stack generates Parameters in AWS Systems Manager Parameter Store, and modifies the CDK application to look up the generated parameter using aws_ssm.StringParameter.valueFromLookup() at synthesis time.
Example on using this method:
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import ResourceExtractor, ResourceExtractorShareMethod
Aspects.of(app).add(
ResourceExtractor(
stack_artifacts=synthed_app.stacks,
resource_types_to_extract=["AWS::IAM::Role", "AWS::IAM::Policy", "AWS::IAM::ManagedPolicy", "AWS::IAM::InstanceProfile"
],
extract_destination_stack=extracted_stack,
value_share_method=ResourceExtractorShareMethod.SSM_PARAMETER
))
API_LOOKUP
The API_LOOKUP sharing method is a work in progress, and not yet supported
Resource Partials
Some resources that get extracted might reference resources that aren't yet created.
In our example CDK application we include the line
# Example automatically generated from non-compiling source. May contain errors.
bucket.grant_read_write(func)
This creates an AWS::IAM::Policy that includes the necessary Actions scoped down to the S3 bucket.
When the AWS::IAM::Policy is extracted, it's unable to use Ref or Fn::GetAtt to reference the S3 bucket since the S3 bucket wasn't extracted.
In this case we substitute the reference with a "partial ARN" that makes a best effort to scope the resources in the IAM policy statement to the ARN of the yet-to-be created S3 bucket.
There are multiple resource types supported out of the box (found in createDefaultTransforms). In the event you have a resource not yet supported, you'll receive a MissingTransformError. In this case you can either open an issue with the resource in question, or you can include the additionalTransforms property.
Consider the following:
# Example automatically generated from non-compiling source. May contain errors.
vpc = Vpc(stack, "TestVpc")
db = DatabaseInstance(stack, "TestDb",
vpc=vpc,
engine=DatabaseInstanceEngine.POSTGRES
)
func = Function(stack, "TestLambda", {
"code": Code.from_asset(path.join(__dirname, "lambda-handler")),
"handler": "index.handler",
"runtime": Runtime.PYTHON_3_11
})
db.secret.grant_read(func)
synthed_app = app.synth()
Aspects.of(app).add(
ResourceExtractor(
extract_destination_stack=extracted_stack,
stack_artifacts=synthed_app.stacks,
value_share_method=ResourceExtractorShareMethod.CFN_OUTPUT,
resource_types_to_extract=["AWS::IAM::Role", "AWS::IAM::Policy"],
additional_transforms={
"AWS::SecretsManager::SecretTargetAttachment": f"arn:{Aws.PARTITION}:secretsmanager:{Aws.REGION}:{Aws.ACCOUNT_ID}:secret:some-expected-value*"
}
))
app.synth(force=True)
In this case, there is a AWS::SecretsManager::SecretTargetAttachment generated to complete the final link between a Secrets Manager secret and the associated database by adding the database connection information to the secret JSON, which returns the ARN of the generated secret.
In the context of extracting the IAM policy, we want to tell the ResourceExtractor how to handle the resource section of the IAM policy statement so that it is scoped down sufficiently.
In this case rather than using a Ref: LogicalIdForTheSecretTargetAttachment we construct the ARN we want to use.
Details in API.md
Generated API.md
Generated API.md below:
Expand to view API docs
CDK Enterprise IaC
Utilities for using CDK within enterprise constraints.
Install
Typescript
npm install @cdklabs/cdk-enterprise-iac
Python
pip install cdklabs.cdk-enterprise-iac
Who this project is for
Within large enterprises, builders can come up against enterprise imposed constraints when deploying on AWS.
This could be simple things such as "All IAM roles must have a specific Permissions Boundary attached".
This could also be more restrictive such as strict separation of duties, only allowing certain teams the ability to deploy specific AWS resources (e.g. Networking team can deploy VPCs, Subnets, and route tables. Security team can deploy IAM resources. Developers can deploy Compute. DBAs can deploy Databases, etc.)
Enterprises with very restrictive environments like these would benefit from taking a closer look at their policies to see how they can allow builders to safely deploy resources with less friction. However in many enterprises this is easier said than done, and builders are still expected to deliver.
This project is meant to reduce friction for builders working within these enterprise constraints while the enterprise determines what policies make the most sense for their organization, and is in no way prescriptive.
Usage
There are many tools available, all detailed in API.md.
A few examples of these tools below:
Adding permissions boundaries to all generated IAM roles
Example for AddPermissionBoundary in Typescript project.
# Example automatically generated from non-compiling source. May contain errors.
import aws_cdk as cdk
from ...lib.my_project_stack import MyStack
from aws_cdk import Aspects
from cdklabs.cdk_enterprise_iac import AddPermissionBoundary
app = cdk.App()
MyStack(app, "MyStack")
Aspects.of(app).add(
AddPermissionBoundary(
permissions_boundary_policy_name="MyPermissionBoundaryName",
instance_profile_prefix="MY_PREFIX_", # optional, Defaults to ''
policy_prefix="MY_POLICY_PREFIX_", # optional, Defaults to ''
role_prefix="MY_ROLE_PREFIX_"
))
Example for AddPermissionBoundary in Python project.
import aws_cdk as cdk
from cdklabs.cdk_enterprise_iac import AddPermissionBoundary
from test_py.test_py_stack import TestPyStack
app = cdk.App()
TestPyStack(app, "TestPyStack")
cdk.Aspects.of(app).add(AddPermissionBoundary(
permissions_boundary_policy_name="MyPermissionBoundaryName",
instance_profile_prefix="MY_PREFIX_", # optional, Defaults to ""
policy_prefix="MY_POLICY_PREFIX_", # optional, Defaults to ""
role_prefix="MY_ROLE_PREFIX_" # optional, Defaults to ""
))
app.synth()
Resource extraction
:warning: Resource extraction is in an experimental phase. Test and validate before using in production. Please open any issues found here.
In many enterprises, there are separate teams with different IAM permissions than developers deploying CDK applications.
For example there might be a networking team with permissions to deploy AWS::EC2::SecurityGroup and AWS::EC2::EIP, or a security team with permissions to deploy AWS::IAM::Role and AWS::IAM::Policy, but the developers deploying the CDK don't have those permissions.
When a developer doesn't have permissions to deploy necessary resources in their CDK application, writing good code becomes difficult to manage when a cdk deploy will quickly error due to not being able to deploy something like an AWS::IAM::Role which is foundational to any project deployed into AWS.
An enterprise should allow builders to deploy these resources via CDK for many reasons, and can use Permissions Boundaries to prevent privilege escalation. For enterprises that haven't yet utilized Permissions Boundaries, the ResourceExtractor can make it easier for builders to write good CDK while complying with enterprise policies.
Using the ResourceExtractor Aspect, developers can write their CDK code as though they had sufficient IAM permissions, but extract those resources into a separate stack for an external team to deploy on their behalf.
Take the following example stack:
# Example automatically generated from non-compiling source. May contain errors.
from aws_cdk import App, Aspects, RemovalPolicy, Stack
from aws_cdk.aws_lambda import Code, Function, Runtime
from aws_cdk.aws_s3 import Bucket
app = App()
app_stack = Stack(app, "MyAppStack")
func = Function(app_stack, "TestLambda",
code=Code.from_asset(path.join(__dirname, "lambda-handler")),
handler="index.handler",
runtime=Runtime.PYTHON_3_11
)
bucket = Bucket(app_stack, "TestBucket",
auto_delete_objects=True,
removal_policy=RemovalPolicy.DESTROY
)
bucket.grant_read_write(func)
app.synth()
The synthesized Cloudformation would include all AWS resources required, including resources a developer might not have permissions to deploy
The above example would include the following snippet in the synthesized Cloudformation
TestLambdaServiceRoleC28C2D9C:
Type: 'AWS::IAM::Role'
Properties:
AssumeRolePolicyDocument:
Statement:
- Action: 'sts:AssumeRole'
Effect: Allow
Principal:
Service: lambda.amazonaws.com
Version: 2012-10-17
# excluding remaining properties
TestLambda2F70C45E:
Type: 'AWS::Lambda::Function'
Properties:
Role: !GetAtt
- TestLambdaServiceRoleC28C2D9C
- Arn
# excluding remaining properties
While including bucket.grantReadWrite(func) in the CDK application ensures an IAM role with least privilege IAM policies for the application, the creation of IAM resources such as Roles and Policies may be restricted to a security team, resulting in the synthesized Cloudformation template not being deployable by a developer.
Using the ResourceExtractor, we can pull out an arbitrary list of Cloudformation resources that a developer doesn't have permissions to provision, and create a separate stack that can be sent to a security team.
# Example automatically generated from non-compiling source. May contain errors.
from aws_cdk import App, Aspects, RemovalPolicy, Stack
from aws_cdk.aws_lambda import Code, Function, Runtime
from aws_cdk.aws_s3 import Bucket
# Import ResourceExtractor
from cdklabs.cdk_enterprise_iac import ResourceExtractor
app = App()
app_stack = Stack(app, "MyAppStack")
# Set up a destination stack to extract resources to
extracted_stack = Stack(app, "ExtractedStack")
func = Function(app_stack, "TestLambda",
code=Code.from_asset(path.join(__dirname, "lambda-handler")),
handler="index.handler",
runtime=Runtime.PYTHON_3_11
)
bucket = Bucket(app_stack, "TestBucket",
auto_delete_objects=True,
removal_policy=RemovalPolicy.DESTROY
)
bucket.grant_read_write(func)
# Capture the output of app.synth()
synthed_app = app.synth()
# Apply the ResourceExtractor Aspect
Aspects.of(app).add(
ResourceExtractor(
# synthesized stacks to examine
stack_artifacts=synthed_app.stacks,
# Array of Cloudformation resources to extract
resource_types_to_extract=["AWS::IAM::Role", "AWS::IAM::Policy", "AWS::IAM::ManagedPolicy", "AWS::IAM::InstanceProfile"
],
# Destination stack for extracted resources
extract_destination_stack=extracted_stack
))
# Resynthing since ResourceExtractor has modified the app
app.synth(force=True)
In the example above, all resources are created in the appStack, and an empty extractedStack is also created.
We apply the ResourceExtractor Aspect, specifying the Cloudformation resource types the developer is unable to deploy due to insufficient IAM permissions.
Now when we list stacks in the CDK project, we can see an added stack
$ cdk ls
MyAppStack
ExtractedStack
Taking a look at these synthesized stacks, in the ExtractedStack we'll find:
Resources:
TestLambdaServiceRoleC28C2D9C:
Type: 'AWS::IAM::Role'
Properties:
AssumeRolePolicyDocument:
Statement:
- Action: 'sts:AssumeRole'
Effect: Allow
Principal:
Service: lambda.amazonaws.com
Version: 2012-10-17
# excluding remaining properties
Outputs:
ExportAppStackTestLambdaServiceRoleC28C2D9C:
Value:
'Fn::GetAtt':
- TestLambdaServiceRoleC28C2D9C
- Arn
Export:
Name: 'AppStack:TestLambdaServiceRoleC28C2D9C' # Exported name
And inside the synthesized MyAppStack template:
Resources:
TestLambda2F70C45E:
Type: 'AWS::Lambda::Function'
Properties:
Role: !ImportValue 'AppStack:TestLambdaServiceRoleC28C2D9C' # Using ImportValue instrinsic function to use pre-created IAM role
# excluding remaining properties
In this scenario, a developer is able to provide an external security team with sufficient IAM privileges to deploy the ExtractedStack.
Once deployed, a developer can run cdk deploy MyAppStack without errors due to insufficient IAM privileges
Value Sharing methods
When resources are extracted from a stack, there must be a method to reference the resources that have been extracted.
There are three methods (see ResourceExtractorShareMethod enum)
CFN_OUTPUTSSM_PARAMETERAPI_LOOKUP
CFN_OUTPUT
The default sharing method is CFN_OUTPUT, which uses Cloudformation Export/Import to Export values in the extracted stack (see Outputs), and use the Fn::ImportValue intrinsic function to reference those values.
This works fine, but some teams may prefer a looser coupling between the extracted stack deployed by an external team and the rest of the CDK infrastructure.
SSM_PARAMETER
In this method, the extracted stack generates Parameters in AWS Systems Manager Parameter Store, and modifies the CDK application to look up the generated parameter using aws_ssm.StringParameter.valueFromLookup() at synthesis time.
Example on using this method:
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import ResourceExtractor, ResourceExtractorShareMethod
Aspects.of(app).add(
ResourceExtractor(
stack_artifacts=synthed_app.stacks,
resource_types_to_extract=["AWS::IAM::Role", "AWS::IAM::Policy", "AWS::IAM::ManagedPolicy", "AWS::IAM::InstanceProfile"
],
extract_destination_stack=extracted_stack,
value_share_method=ResourceExtractorShareMethod.SSM_PARAMETER
))
API_LOOKUP
The API_LOOKUP sharing method is a work in progress, and not yet supported
Resource Partials
Some resources that get extracted might reference resources that aren't yet created.
In our example CDK application we include the line
# Example automatically generated from non-compiling source. May contain errors.
bucket.grant_read_write(func)
This creates an AWS::IAM::Policy that includes the necessary Actions scoped down to the S3 bucket.
When the AWS::IAM::Policy is extracted, it's unable to use Ref or Fn::GetAtt to reference the S3 bucket since the S3 bucket wasn't extracted.
In this case we substitute the reference with a "partial ARN" that makes a best effort to scope the resources in the IAM policy statement to the ARN of the yet-to-be created S3 bucket.
There are multiple resource types supported out of the box (found in createDefaultTransforms). In the event you have a resource not yet supported, you'll receive a MissingTransformError. In this case you can either open an issue with the resource in question, or you can include the additionalTransforms property.
Consider the following:
# Example automatically generated from non-compiling source. May contain errors.
vpc = Vpc(stack, "TestVpc")
db = DatabaseInstance(stack, "TestDb",
vpc=vpc,
engine=DatabaseInstanceEngine.POSTGRES
)
func = Function(stack, "TestLambda", {
"code": Code.from_asset(path.join(__dirname, "lambda-handler")),
"handler": "index.handler",
"runtime": Runtime.PYTHON_3_11
})
db.secret.grant_read(func)
synthed_app = app.synth()
Aspects.of(app).add(
ResourceExtractor(
extract_destination_stack=extracted_stack,
stack_artifacts=synthed_app.stacks,
value_share_method=ResourceExtractorShareMethod.CFN_OUTPUT,
resource_types_to_extract=["AWS::IAM::Role", "AWS::IAM::Policy"],
additional_transforms={
"AWS::SecretsManager::SecretTargetAttachment": f"arn:{Aws.PARTITION}:secretsmanager:{Aws.REGION}:{Aws.ACCOUNT_ID}:secret:some-expected-value*"
}
))
app.synth(force=True)
In this case, there is a AWS::SecretsManager::SecretTargetAttachment generated to complete the final link between a Secrets Manager secret and the associated database by adding the database connection information to the secret JSON, which returns the ARN of the generated secret.
In the context of extracting the IAM policy, we want to tell the ResourceExtractor how to handle the resource section of the IAM policy statement so that it is scoped down sufficiently.
In this case rather than using a Ref: LogicalIdForTheSecretTargetAttachment we construct the ARN we want to use.
Details in API.md
Generated API.md
Generated API.md below:
Expand to view API docs
API Reference
Constructs
EcsIsoServiceAutoscaler
Creates a EcsIsoServiceAutoscaler construct.
This construct allows you to scale an ECS service in an ISO region where classic ECS Autoscaling may not be available.
Initializers
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import EcsIsoServiceAutoscaler
EcsIsoServiceAutoscaler(scope, Construct, id, string, props, EcsIsoServiceAutoscalerProps)
| Name | Type | Description |
|---|---|---|
scope |
constructs.Construct |
No description. |
id |
string |
No description. |
props |
EcsIsoServiceAutoscalerProps |
No description. |
scopeRequired
- Type: constructs.Construct
idRequired
- Type: string
propsRequired
Methods
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
toString
# Example automatically generated from non-compiling source. May contain errors.
to_string()string
Returns a string representation of this construct.
Static Functions
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isConstruct
isConstruct# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import EcsIsoServiceAutoscaler
EcsIsoServiceAutoscaler.is_construct(x, any)
Checks if x is a construct.
xRequired
- Type: any
Any object.
Properties
| Name | Type | Description |
|---|---|---|
node |
constructs.Node |
The tree node. |
ecsScalingManagerFunction |
aws-cdk-lib.aws_lambda.Function |
No description. |
nodeRequired
# Example automatically generated from non-compiling source. May contain errors.
node: Node;
- Type: constructs.Node
The tree node.
ecsScalingManagerFunctionRequired
ecsScalingManagerFunction: Function;
- Type: aws-cdk-lib.aws_lambda.Function
PopulateWithConfig
Populate a provided VPC with subnets based on a provided configuration.
Example
# Example automatically generated from non-compiling source. May contain errors.
my_subnet_config = [{
"group_name": "app",
"cidr_range": "172.31.0.0/27",
"availability_zone": "a",
"subnet_type": subnet_type.PUBLIC
}, {
"group_name": "app",
"cidr_range": "172.31.0.32/27",
"availability_zone": "b",
"subnet_type": subnet_type.PUBLIC
}, {
"group_name": "db",
"cidr_range": "172.31.0.64/27",
"availability_zone": "a",
"subnet_type": subnet_type.PRIVATE_WITH_EGRESS
}, {
"group_name": "db",
"cidr_range": "172.31.0.96/27",
"availability_zone": "b",
"subnet_type": subnet_type.PRIVATE_WITH_EGRESS
}, {
"group_name": "iso",
"cidr_range": "172.31.0.128/26",
"availability_zone": "a",
"subnet_type": subnet_type.PRIVATE_ISOLATED
}, {
"group_name": "iso",
"cidr_range": "172.31.0.196/26",
"availability_zone": "b",
"subnet_type": subnet_type.PRIVATE_ISOLATED
}
]
PopulateWithConfig(self, "vpcPopulater",
vpc_id="vpc-abcdefg1234567",
private_route_table_id="rt-abcdefg123456",
local_route_table_id="rt-123456abcdefg",
subnet_config=my_subnet_config
)
Initializers
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import PopulateWithConfig
PopulateWithConfig(scope, Construct, id, string, props, PopulateWithConfigProps)
| Name | Type | Description |
|---|---|---|
scope |
constructs.Construct |
No description. |
id |
string |
No description. |
props |
PopulateWithConfigProps |
No description. |
scopeRequired
- Type: constructs.Construct
idRequired
- Type: string
propsRequired
- Type: PopulateWithConfigProps
Methods
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
toString
# Example automatically generated from non-compiling source. May contain errors.
to_string()string
Returns a string representation of this construct.
Static Functions
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isConstruct
isConstruct# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import PopulateWithConfig
PopulateWithConfig.is_construct(x, any)
Checks if x is a construct.
xRequired
- Type: any
Any object.
Properties
| Name | Type | Description |
|---|---|---|
node |
constructs.Node |
The tree node. |
nodeRequired
# Example automatically generated from non-compiling source. May contain errors.
node: Node;
- Type: constructs.Node
The tree node.
SplitVpcEvenly
Splits a VPC evenly between a provided number of AZs (3 if not defined), and attaches a provided route table to each, and labels.
Example
# Example automatically generated from non-compiling source. May contain errors.
# with more specific properties
SplitVpcEvenly(self, "evenSplitVpc",
vpc_id="vpc-abcdefg123456",
vpc_cidr="172.16.0.0/16",
route_table_id="rt-abcdefgh123456",
cidr_bits="10",
number_of_azs=4,
subnet_type=subnet_type.PRIVATE_ISOLATED
)
Initializers
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import SplitVpcEvenly
SplitVpcEvenly(scope, Construct, id, string, props, SplitVpcEvenlyProps)
| Name | Type | Description |
|---|---|---|
scope |
constructs.Construct |
No description. |
id |
string |
No description. |
props |
SplitVpcEvenlyProps |
No description. |
scopeRequired
- Type: constructs.Construct
idRequired
- Type: string
propsRequired
- Type: SplitVpcEvenlyProps
Methods
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
toString
# Example automatically generated from non-compiling source. May contain errors.
to_string()string
Returns a string representation of this construct.
Static Functions
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isConstruct
isConstruct# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import SplitVpcEvenly
SplitVpcEvenly.is_construct(x, any)
Checks if x is a construct.
xRequired
- Type: any
Any object.
Properties
| Name | Type | Description |
|---|---|---|
node |
constructs.Node |
The tree node. |
nodeRequired
# Example automatically generated from non-compiling source. May contain errors.
node: Node;
- Type: constructs.Node
The tree node.
Structs
AddCfnInitProxyProps
Properties for the proxy server to use with cfn helper commands.
Initializer
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import AddCfnInitProxyProps
add_cfn_init_proxy_props = AddCfnInitProxyProps(...)
Properties
| Name | Type | Description |
|---|---|---|
proxyHost |
string |
host of your proxy. |
proxyPort |
number |
proxy port. |
proxyCredentials |
aws-cdk-lib.aws_secretsmanager.ISecret |
JSON secret containing user and password properties to use if your proxy requires credentials http://user:password@host:port could contain sensitive data, so using a Secret. |
proxyType |
ProxyType |
Proxy Type. |
proxyHostRequired
# Example automatically generated from non-compiling source. May contain errors.
proxyHost: string;
- Type: string
host of your proxy.
Example
# Example automatically generated from non-compiling source. May contain errors.
example.com
proxyPortRequired
# Example automatically generated from non-compiling source. May contain errors.
proxyPort: number;
- Type: number
proxy port.
Example
8080
proxyCredentialsOptional
# Example automatically generated from non-compiling source. May contain errors.
proxyCredentials: ISecret;
- Type: aws-cdk-lib.aws_secretsmanager.ISecret
JSON secret containing user and password properties to use if your proxy requires credentials http://user:password@host:port could contain sensitive data, so using a Secret.
Note that while the user and password won't be visible in the cloudformation template
they will be in plain text inside your UserData
Example
# Example automatically generated from non-compiling source. May contain errors.
secret = Secret(stack, "TestSecret",
secret_object_value={
"user": SecretValue,
"password": SecretValue
}
)
proxyTypeOptional
# Example automatically generated from non-compiling source. May contain errors.
proxyType: ProxyType;
- Type: ProxyType
- Default: ProxyType.HTTP
Proxy Type.
Example
# Example automatically generated from non-compiling source. May contain errors.
ProxyType.HTTPS
AddPermissionBoundaryProps
Properties to pass to the AddPermissionBoundary.
Initializer
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import AddPermissionBoundaryProps
add_permission_boundary_props = AddPermissionBoundaryProps(...)
Properties
| Name | Type | Description |
|---|---|---|
permissionsBoundaryPolicyName |
string |
Name of Permissions Boundary Policy to add to all IAM roles. |
instanceProfilePrefix |
string |
A prefix to prepend to the name of the IAM InstanceProfiles (Default: ''). |
policyPrefix |
string |
A prefix to prepend to the name of the IAM Policies and ManagedPolicies (Default: ''). |
rolePrefix |
string |
A prefix to prepend to the name of IAM Roles (Default: ''). |
permissionsBoundaryPolicyNameRequired
# Example automatically generated from non-compiling source. May contain errors.
permissionsBoundaryPolicyName: string;
- Type: string
Name of Permissions Boundary Policy to add to all IAM roles.
instanceProfilePrefixOptional
# Example automatically generated from non-compiling source. May contain errors.
instanceProfilePrefix: string;
- Type: string
A prefix to prepend to the name of the IAM InstanceProfiles (Default: '').
policyPrefixOptional
# Example automatically generated from non-compiling source. May contain errors.
policyPrefix: string;
- Type: string
A prefix to prepend to the name of the IAM Policies and ManagedPolicies (Default: '').
rolePrefixOptional
# Example automatically generated from non-compiling source. May contain errors.
rolePrefix: string;
- Type: string
A prefix to prepend to the name of IAM Roles (Default: '').
EcsIsoServiceAutoscalerProps
Initializer
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import EcsIsoServiceAutoscalerProps
ecs_iso_service_autoscaler_props = EcsIsoServiceAutoscalerProps(...)
Properties
| Name | Type | Description |
|---|---|---|
ecsCluster |
aws-cdk-lib.aws_ecs.Cluster |
The cluster the service you wish to scale resides in. |
ecsService |
aws-cdk-lib.aws_ecs.IService |
The ECS service you wish to scale. |
scaleAlarm |
aws-cdk-lib.aws_cloudwatch.AlarmBase |
The Cloudwatch Alarm that will cause scaling actions to be invoked, whether it's in or not in alarm will determine scale up and down actions. |
maximumTaskCount |
number |
The maximum number of tasks that the service will scale out to. |
minimumTaskCount |
number |
The minimum number of tasks the service will have. |
role |
aws-cdk-lib.aws_iam.IRole |
Optional IAM role to attach to the created lambda to adjust the desired count on the ECS Service. |
scaleInCooldown |
aws-cdk-lib.Duration |
How long will the application wait before performing another scale in action. |
scaleInIncrement |
number |
The number of tasks that will scale in on scale in alarm status. |
scaleOutCooldown |
aws-cdk-lib.Duration |
How long will a the application wait before performing another scale out action. |
scaleOutIncrement |
number |
The number of tasks that will scale out on scale out alarm status. |
ecsClusterRequired
# Example automatically generated from non-compiling source. May contain errors.
ecsCluster: Cluster;
- Type: aws-cdk-lib.aws_ecs.Cluster
The cluster the service you wish to scale resides in.
ecsServiceRequired
# Example automatically generated from non-compiling source. May contain errors.
ecsService: IService;
- Type: aws-cdk-lib.aws_ecs.IService
The ECS service you wish to scale.
scaleAlarmRequired
# Example automatically generated from non-compiling source. May contain errors.
scaleAlarm: AlarmBase;
- Type: aws-cdk-lib.aws_cloudwatch.AlarmBase
The Cloudwatch Alarm that will cause scaling actions to be invoked, whether it's in or not in alarm will determine scale up and down actions.
Note: composite alarms can not be generated with CFN in all regions, while this allows you to pass in a composite alarm alarm creation is outside the scope of this construct
maximumTaskCountOptional
# Example automatically generated from non-compiling source. May contain errors.
maximumTaskCount: number;
- Type: number
- Default: 10
The maximum number of tasks that the service will scale out to.
Note: This does not provide any protection from scaling out above the maximum allowed in your account, set this variable and manage account quotas appropriately.
minimumTaskCountOptional
# Example automatically generated from non-compiling source. May contain errors.
minimumTaskCount: number;
- Type: number
- Default: 1
The minimum number of tasks the service will have.
roleOptional
# Example automatically generated from non-compiling source. May contain errors.
role: IRole;
- Type: aws-cdk-lib.aws_iam.IRole
- Default: A role is created for you with least privilege IAM policy
Optional IAM role to attach to the created lambda to adjust the desired count on the ECS Service.
Ensure this role has appropriate privileges. Example IAM policy statements:
{
"PolicyDocument": {
"Statement": [
{
"Action": "cloudwatch:DescribeAlarms",
"Effect": "Allow",
"Resource": "*"
},
{
"Action": [
"ecs:DescribeServices",
"ecs:UpdateService"
],
"Condition": {
"StringEquals": {
"ecs:cluster": "arn:${Partition}:ecs:${Region}:${Account}:cluster/${ClusterName}"
}
},
"Effect": "Allow",
"Resource": "arn:${Partition}:ecs:${Region}:${Account}:service/${ClusterName}/${ServiceName}"
}
],
"Version": "2012-10-17"
}
}
scaleInCooldownOptional
# Example automatically generated from non-compiling source. May contain errors.
scaleInCooldown: Duration;
- Type: aws-cdk-lib.Duration
- Default: 60 seconds
How long will the application wait before performing another scale in action.
scaleInIncrementOptional
# Example automatically generated from non-compiling source. May contain errors.
scaleInIncrement: number;
- Type: number
- Default: 1
The number of tasks that will scale in on scale in alarm status.
scaleOutCooldownOptional
# Example automatically generated from non-compiling source. May contain errors.
scaleOutCooldown: Duration;
- Type: aws-cdk-lib.Duration
- Default: 60 seconds
How long will a the application wait before performing another scale out action.
scaleOutIncrementOptional
# Example automatically generated from non-compiling source. May contain errors.
scaleOutIncrement: number;
- Type: number
- Default: 1
The number of tasks that will scale out on scale out alarm status.
PopulateWithConfigProps
Initializer
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import PopulateWithConfigProps
populate_with_config_props = PopulateWithConfigProps(...)
Properties
| Name | Type | Description |
|---|---|---|
localRouteTableId |
string |
Local route table ID, with routes only to local VPC. |
privateRouteTableId |
string |
Route table ID for a provided route table with routes to enterprise network. |
subnetConfig |
SubnetConfig[] |
List of Subnet configs to provision to provision. |
vpcId |
string |
ID of the VPC provided that needs to be populated. |
localRouteTableIdRequired
# Example automatically generated from non-compiling source. May contain errors.
localRouteTableId: string;
- Type: string
Local route table ID, with routes only to local VPC.
privateRouteTableIdRequired
# Example automatically generated from non-compiling source. May contain errors.
privateRouteTableId: string;
- Type: string
Route table ID for a provided route table with routes to enterprise network.
Both subnetType.PUBLIC and subnetType.PRIVATE_WITH_EGRESS will use this property
subnetConfigRequired
# Example automatically generated from non-compiling source. May contain errors.
subnetConfig: SubnetConfig[];
- Type: SubnetConfig[]
List of Subnet configs to provision to provision.
vpcIdRequired
# Example automatically generated from non-compiling source. May contain errors.
vpcId: string;
- Type: string
ID of the VPC provided that needs to be populated.
RemoveTagsProps
Initializer
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import RemoveTagsProps
remove_tags_props = RemoveTagsProps(...)
Properties
| Name | Type | Description |
|---|---|---|
cloudformationResource |
string |
Name of Cloudformation resource Type (e.g. 'AWS::Lambda::Function'). |
tagPropertyName |
string |
Name of the tag property to remove from the resource. |
cloudformationResourceRequired
# Example automatically generated from non-compiling source. May contain errors.
cloudformationResource: string;
- Type: string
Name of Cloudformation resource Type (e.g. 'AWS::Lambda::Function').
tagPropertyNameOptional
# Example automatically generated from non-compiling source. May contain errors.
tagPropertyName: string;
- Type: string
- Default: Tags
Name of the tag property to remove from the resource.
ResourceExtractorProps
Initializer
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import ResourceExtractorProps
resource_extractor_props = ResourceExtractorProps(...)
Properties
| Name | Type | Description |
|---|---|---|
extractDestinationStack |
aws-cdk-lib.Stack |
Stack to move found extracted resources into. |
resourceTypesToExtract |
string[] |
List of resource types to extract, ex: AWS::IAM::Role. |
stackArtifacts |
aws-cdk-lib.cx_api.CloudFormationStackArtifact[] |
Synthed stack artifacts from your CDK app. |
additionalTransforms |
{[ key: string ]: string} |
Additional resource transformations. |
valueShareMethod |
ResourceExtractorShareMethod |
The sharing method to use when passing exported resources from the "Extracted Stack" into the original stack(s). |
extractDestinationStackRequired
extractDestinationStack: Stack;
- Type: aws-cdk-lib.Stack
Stack to move found extracted resources into.
resourceTypesToExtractRequired
# Example automatically generated from non-compiling source. May contain errors.
resourceTypesToExtract: string[];
- Type: string[]
List of resource types to extract, ex: AWS::IAM::Role.
stackArtifactsRequired
# Example automatically generated from non-compiling source. May contain errors.
stackArtifacts: CloudFormationStackArtifact[];
- Type: aws-cdk-lib.cx_api.CloudFormationStackArtifact[]
Synthed stack artifacts from your CDK app.
additionalTransformsOptional
# Example automatically generated from non-compiling source. May contain errors.
additionalTransforms: {[ key: string ]: string}
- Type: {[ key: string ]: string}
Additional resource transformations.
valueShareMethodOptional
# Example automatically generated from non-compiling source. May contain errors.
valueShareMethod: ResourceExtractorShareMethod;
The sharing method to use when passing exported resources from the "Extracted Stack" into the original stack(s).
SetApiGatewayEndpointConfigurationProps
Initializer
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import SetApiGatewayEndpointConfigurationProps
set_api_gateway_endpoint_configuration_props = SetApiGatewayEndpointConfigurationProps(...)
Properties
| Name | Type | Description |
|---|---|---|
endpointType |
aws-cdk-lib.aws_apigateway.EndpointType |
API Gateway endpoint type to override to. |
endpointTypeOptional
# Example automatically generated from non-compiling source. May contain errors.
endpointType: EndpointType;
- Type: aws-cdk-lib.aws_apigateway.EndpointType
- Default: EndpointType.REGIONAL
API Gateway endpoint type to override to.
Defaults to EndpointType.REGIONAL
SplitVpcEvenlyProps
Initializer
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import SplitVpcEvenlyProps
split_vpc_evenly_props = SplitVpcEvenlyProps(...)
Properties
| Name | Type | Description |
|---|---|---|
routeTableId |
string |
Route Table ID that will be attached to each subnet created. |
vpcCidr |
string |
CIDR range of the VPC you're populating. |
vpcId |
string |
ID of the existing VPC you're trying to populate. |
cidrBits |
string |
cidrBits argument for the Fn::Cidr Cloudformation intrinsic function. |
numberOfAzs |
number |
Number of AZs to evenly split into. |
subnetType |
aws-cdk-lib.aws_ec2.SubnetType |
No description. |
routeTableIdRequired
# Example automatically generated from non-compiling source. May contain errors.
routeTableId: string;
- Type: string
Route Table ID that will be attached to each subnet created.
vpcCidrRequired
# Example automatically generated from non-compiling source. May contain errors.
vpcCidr: string;
- Type: string
CIDR range of the VPC you're populating.
vpcIdRequired
# Example automatically generated from non-compiling source. May contain errors.
vpcId: string;
- Type: string
ID of the existing VPC you're trying to populate.
cidrBitsOptional
# Example automatically generated from non-compiling source. May contain errors.
cidrBits: string;
- Type: string
- Default: '6'
cidrBits argument for the Fn::Cidr Cloudformation intrinsic function.
numberOfAzsOptional
# Example automatically generated from non-compiling source. May contain errors.
numberOfAzs: number;
- Type: number
- Default: 3
Number of AZs to evenly split into.
subnetTypeOptional
# Example automatically generated from non-compiling source. May contain errors.
subnetType: SubnetType;
- Type: aws-cdk-lib.aws_ec2.SubnetType
- Default: subnetType.PRIVATE
SubnetConfig
Initializer
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import SubnetConfig
subnet_config = SubnetConfig(...)
Properties
| Name | Type | Description |
|---|---|---|
availabilityZone |
string |
Which availability zone the subnet should be in. |
cidrRange |
string |
Cidr range of the subnet to create. |
groupName |
string |
Logical group name of a subnet. |
subnetType |
aws-cdk-lib.aws_ec2.SubnetType |
What SubnetType to use. |
availabilityZoneRequired
# Example automatically generated from non-compiling source. May contain errors.
availabilityZone: string;
- Type: string
Which availability zone the subnet should be in.
cidrRangeRequired
# Example automatically generated from non-compiling source. May contain errors.
cidrRange: string;
- Type: string
Cidr range of the subnet to create.
groupNameRequired
# Example automatically generated from non-compiling source. May contain errors.
groupName: string;
- Type: string
Logical group name of a subnet.
Example
# Example automatically generated from non-compiling source. May contain errors.
db
subnetTypeRequired
# Example automatically generated from non-compiling source. May contain errors.
subnetType: SubnetType;
- Type: aws-cdk-lib.aws_ec2.SubnetType
What SubnetType to use.
This will govern the aws-cdk:subnet-type tag on the subnet
| SubnetType | aws-cdk:subnet-type tag value |
|---|---|
PRIVATE_ISOLATED |
'Isolated' |
PRIVATE_WITH_EGRESS |
'Private' |
PUBLIC |
'Public' |
Classes
AddCfnInitProxy
- Implements: aws-cdk-lib.IAspect
Add proxy configuration to Cloudformation helper functions.
Initializers
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import AddCfnInitProxy
AddCfnInitProxy(props, AddCfnInitProxyProps)
| Name | Type | Description |
|---|---|---|
props |
AddCfnInitProxyProps |
No description. |
propsRequired
- Type: AddCfnInitProxyProps
Methods
| Name | Description |
|---|---|
visit |
All aspects can visit an IConstruct. |
visit
# Example automatically generated from non-compiling source. May contain errors.
visit(node, IConstruct)
All aspects can visit an IConstruct.
nodeRequired
- Type: constructs.IConstruct
AddLambdaEnvironmentVariables
- Implements: aws-cdk-lib.IAspect
Add one or more environment variables to all lambda functions within a scope.
Initializers
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import AddLambdaEnvironmentVariables
AddLambdaEnvironmentVariables(props, {"key": string, "string": string})
| Name | Type | Description |
|---|---|---|
props |
{[ key: string ]: string} |
: string} props - Key Value pair(s) for environment variables to add to all lambda functions. |
propsRequired
- Type: {[ key: string ]: string}
: string} props - Key Value pair(s) for environment variables to add to all lambda functions.
Methods
| Name | Description |
|---|---|
visit |
All aspects can visit an IConstruct. |
visit
# Example automatically generated from non-compiling source. May contain errors.
visit(node, IConstruct)
All aspects can visit an IConstruct.
nodeRequired
- Type: constructs.IConstruct
AddPermissionBoundary
- Implements: aws-cdk-lib.IAspect
A patch for Adding Permissions Boundaries to all IAM roles.
Additional options for adding prefixes to IAM role, policy and instance profile names
Can account for non commercial partitions (e.g. aws-gov, aws-cn)
Initializers
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import AddPermissionBoundary
AddPermissionBoundary(props, AddPermissionBoundaryProps)
| Name | Type | Description |
|---|---|---|
props |
AddPermissionBoundaryProps |
No description. |
propsRequired
Methods
| Name | Description |
|---|---|
checkAndOverride |
No description. |
visit |
All aspects can visit an IConstruct. |
checkAndOverride
# Example automatically generated from non-compiling source. May contain errors.
check_and_override(node, CfnResource, prefix, string, length, number, cfn_prop, string, cdkProp?: string)
nodeRequired
- Type: aws-cdk-lib.CfnResource
prefixRequired
- Type: string
lengthRequired
- Type: number
cfnPropRequired
- Type: string
cdkPropOptional
- Type: string
visit
# Example automatically generated from non-compiling source. May contain errors.
visit(node, IConstruct)
All aspects can visit an IConstruct.
nodeRequired
- Type: constructs.IConstruct
ConvertInlinePoliciesToManaged
- Implements: aws-cdk-lib.IAspect
Patch for turning all Policies into ConvertInlinePoliciesToManaged.
Some users have policies in place that make it impossible to create inline policies. Instead, they must use managed policies.
Note that order matters with this aspect. Specifically, it should generally be added first. This is because other aspects may add overrides that would be lost if applied before this aspect since the original aspect is removed and replaced.
Example
# Example automatically generated from non-compiling source. May contain errors.
# Replace all AWS::IAM::Policy resources with equivalent AWS::IAM::ManagedPolicy
Aspects.of(stack).add(ConvertInlinePoliciesToManaged())
Initializers
from cdklabs.cdk_enterprise_iac import ConvertInlinePoliciesToManaged
ConvertInlinePoliciesToManaged()
| Name | Type | Description |
|---|
Methods
| Name | Description |
|---|---|
visit |
All aspects can visit an IConstruct. |
visit
# Example automatically generated from non-compiling source. May contain errors.
visit(node, IConstruct)
All aspects can visit an IConstruct.
nodeRequired
- Type: constructs.IConstruct
RemovePublicAccessBlockConfiguration
- Implements: aws-cdk-lib.IAspect
Looks for S3 Buckets, and removes the PublicAccessBlockConfiguration property.
For use in regions where Cloudformation doesn't support this property
Initializers
from cdklabs.cdk_enterprise_iac import RemovePublicAccessBlockConfiguration
RemovePublicAccessBlockConfiguration()
| Name | Type | Description |
|---|
Methods
| Name | Description |
|---|---|
visit |
All aspects can visit an IConstruct. |
visit
# Example automatically generated from non-compiling source. May contain errors.
visit(node, IConstruct)
All aspects can visit an IConstruct.
nodeRequired
- Type: constructs.IConstruct
RemoveTags
- Implements: aws-cdk-lib.IAspect
Patch for removing tags from a specific Cloudformation Resource.
In some regions, the 'Tags' property isn't supported in Cloudformation. This patch makes it easy to remove
Example
# Example automatically generated from non-compiling source. May contain errors.
# Remove tags on a resource
Aspects.of(stack).add(RemoveTags(
cloudformation_resource="AWS::ECS::Cluster"
))
# Remove tags without the standard 'Tags' name
Aspects.of(stack).add(RemoveTags(
cloudformation_resource="AWS::Backup::BackupPlan",
tag_property_name="BackupPlanTags"
))
Initializers
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import RemoveTags
RemoveTags(props, RemoveTagsProps)
| Name | Type | Description |
|---|---|---|
props |
RemoveTagsProps |
No description. |
propsRequired
- Type: RemoveTagsProps
Methods
| Name | Description |
|---|---|
visit |
All aspects can visit an IConstruct. |
visit
# Example automatically generated from non-compiling source. May contain errors.
visit(node, IConstruct)
All aspects can visit an IConstruct.
nodeRequired
- Type: constructs.IConstruct
ResourceExtractor
- Implements: aws-cdk-lib.IAspect
This Aspect takes a CDK application, all synthesized CloudFormationStackArtifact, a value share method, and a list of Cloudformation resources that should be pulled out of the main CDK application, which should be synthesized to a cloudformation template that an external team (e.g. security team) to deploy, and adjusting the CDK application to reference pre-created resources already pulled out.
Example
# Example automatically generated from non-compiling source. May contain errors.
app = App()
stack = Stack(app, "MyStack")
extracted_stack = Stack(app, "ExtractedStack")
synthed_app = app.synth()
Aspects.of(app).add(ResourceExtractor(
extract_destination_stack=extracted_stack,
stack_artifacts=synthed_app.stacks,
value_share_method=ResourceExtractorShareMethod.CFN_OUTPUT,
resource_types_to_extract=["AWS::IAM::Role", "AWS::IAM::Policy", "AWS::IAM::ManagedPolicy", "AWS::IAM::InstanceProfile"
]
))
app.synth(force=True)
Initializers
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import ResourceExtractor
ResourceExtractor(props, ResourceExtractorProps)
| Name | Type | Description |
|---|---|---|
props |
ResourceExtractorProps |
No description. |
propsRequired
- Type: ResourceExtractorProps
Methods
| Name | Description |
|---|---|
visit |
Entrypoint. |
visit
# Example automatically generated from non-compiling source. May contain errors.
visit(node, IConstruct)
Entrypoint.
nodeRequired
- Type: constructs.IConstruct
SetApiGatewayEndpointConfiguration
- Implements: aws-cdk-lib.IAspect
Override RestApis to use a set endpoint configuration.
Some regions don't support EDGE endpoints, and some enterprises require specific endpoint types for RestApis
Initializers
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import SetApiGatewayEndpointConfiguration
SetApiGatewayEndpointConfiguration(props?: SetApiGatewayEndpointConfigurationProps)
| Name | Type | Description |
|---|---|---|
props |
SetApiGatewayEndpointConfigurationProps |
No description. |
propsOptional
Methods
| Name | Description |
|---|---|
visit |
All aspects can visit an IConstruct. |
visit
# Example automatically generated from non-compiling source. May contain errors.
visit(node, IConstruct)
All aspects can visit an IConstruct.
nodeRequired
- Type: constructs.IConstruct
Enums
ProxyType
Whether an http-proxy or https-proxy.
Members
| Name | Description |
|---|---|
HTTP |
--http-proxy. |
HTTPS |
--https-proxy. |
HTTP
-http-proxy.
HTTPS
-https-proxy.
ResourceExtractorShareMethod
The available value sharing methods to pass values from the extracted stack onto the original stack(s).
Members
| Name | Description |
|---|---|
CFN_OUTPUT |
No description. |
SSM_PARAMETER |
No description. |
API_LOOKUP |
No description. |
CFN_OUTPUT
SSM_PARAMETER
API_LOOKUP
ResourceTransform
Members
| Name | Description |
|---|---|
STACK_NAME |
No description. |
LOGICAL_ID |
No description. |
STACK_NAME
LOGICAL_ID
API Reference
Constructs
EcsIsoServiceAutoscaler
Creates a EcsIsoServiceAutoscaler construct.
This construct allows you to scale an ECS service in an ISO region where classic ECS Autoscaling may not be available.
Initializers
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import EcsIsoServiceAutoscaler
EcsIsoServiceAutoscaler(scope, Construct, id, string, props, EcsIsoServiceAutoscalerProps)
| Name | Type | Description |
|---|---|---|
scope |
constructs.Construct |
No description. |
id |
string |
No description. |
props |
EcsIsoServiceAutoscalerProps |
No description. |
scopeRequired
- Type: constructs.Construct
idRequired
- Type: string
propsRequired
Methods
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
toString
# Example automatically generated from non-compiling source. May contain errors.
to_string()string
Returns a string representation of this construct.
Static Functions
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isConstruct
isConstruct# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import EcsIsoServiceAutoscaler
EcsIsoServiceAutoscaler.is_construct(x, any)
Checks if x is a construct.
xRequired
- Type: any
Any object.
Properties
| Name | Type | Description |
|---|---|---|
node |
constructs.Node |
The tree node. |
ecsScalingManagerFunction |
aws-cdk-lib.aws_lambda.Function |
No description. |
nodeRequired
# Example automatically generated from non-compiling source. May contain errors.
node: Node;
- Type: constructs.Node
The tree node.
ecsScalingManagerFunctionRequired
ecsScalingManagerFunction: Function;
- Type: aws-cdk-lib.aws_lambda.Function
PopulateWithConfig
Populate a provided VPC with subnets based on a provided configuration.
Example
# Example automatically generated from non-compiling source. May contain errors.
my_subnet_config = [{
"group_name": "app",
"cidr_range": "172.31.0.0/27",
"availability_zone": "a",
"subnet_type": subnet_type.PUBLIC
}, {
"group_name": "app",
"cidr_range": "172.31.0.32/27",
"availability_zone": "b",
"subnet_type": subnet_type.PUBLIC
}, {
"group_name": "db",
"cidr_range": "172.31.0.64/27",
"availability_zone": "a",
"subnet_type": subnet_type.PRIVATE_WITH_EGRESS
}, {
"group_name": "db",
"cidr_range": "172.31.0.96/27",
"availability_zone": "b",
"subnet_type": subnet_type.PRIVATE_WITH_EGRESS
}, {
"group_name": "iso",
"cidr_range": "172.31.0.128/26",
"availability_zone": "a",
"subnet_type": subnet_type.PRIVATE_ISOLATED
}, {
"group_name": "iso",
"cidr_range": "172.31.0.196/26",
"availability_zone": "b",
"subnet_type": subnet_type.PRIVATE_ISOLATED
}
]
PopulateWithConfig(self, "vpcPopulater",
vpc_id="vpc-abcdefg1234567",
private_route_table_id="rt-abcdefg123456",
local_route_table_id="rt-123456abcdefg",
subnet_config=my_subnet_config
)
Initializers
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import PopulateWithConfig
PopulateWithConfig(scope, Construct, id, string, props, PopulateWithConfigProps)
| Name | Type | Description |
|---|---|---|
scope |
constructs.Construct |
No description. |
id |
string |
No description. |
props |
PopulateWithConfigProps |
No description. |
scopeRequired
- Type: constructs.Construct
idRequired
- Type: string
propsRequired
- Type: PopulateWithConfigProps
Methods
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
toString
# Example automatically generated from non-compiling source. May contain errors.
to_string()string
Returns a string representation of this construct.
Static Functions
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isConstruct
isConstruct# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import PopulateWithConfig
PopulateWithConfig.is_construct(x, any)
Checks if x is a construct.
xRequired
- Type: any
Any object.
Properties
| Name | Type | Description |
|---|---|---|
node |
constructs.Node |
The tree node. |
nodeRequired
# Example automatically generated from non-compiling source. May contain errors.
node: Node;
- Type: constructs.Node
The tree node.
SplitVpcEvenly
Splits a VPC evenly between a provided number of AZs (3 if not defined), and attaches a provided route table to each, and labels.
Example
# Example automatically generated from non-compiling source. May contain errors.
# with more specific properties
SplitVpcEvenly(self, "evenSplitVpc",
vpc_id="vpc-abcdefg123456",
vpc_cidr="172.16.0.0/16",
route_table_id="rt-abcdefgh123456",
cidr_bits="10",
number_of_azs=4,
subnet_type=subnet_type.PRIVATE_ISOLATED
)
Initializers
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import SplitVpcEvenly
SplitVpcEvenly(scope, Construct, id, string, props, SplitVpcEvenlyProps)
| Name | Type | Description |
|---|---|---|
scope |
constructs.Construct |
No description. |
id |
string |
No description. |
props |
SplitVpcEvenlyProps |
No description. |
scopeRequired
- Type: constructs.Construct
idRequired
- Type: string
propsRequired
- Type: SplitVpcEvenlyProps
Methods
| Name | Description |
|---|---|
toString |
Returns a string representation of this construct. |
toString
# Example automatically generated from non-compiling source. May contain errors.
to_string()string
Returns a string representation of this construct.
Static Functions
| Name | Description |
|---|---|
isConstruct |
Checks if x is a construct. |
isConstruct
isConstruct# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import SplitVpcEvenly
SplitVpcEvenly.is_construct(x, any)
Checks if x is a construct.
xRequired
- Type: any
Any object.
Properties
| Name | Type | Description |
|---|---|---|
node |
constructs.Node |
The tree node. |
nodeRequired
# Example automatically generated from non-compiling source. May contain errors.
node: Node;
- Type: constructs.Node
The tree node.
Structs
AddCfnInitProxyProps
Properties for the proxy server to use with cfn helper commands.
Initializer
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import AddCfnInitProxyProps
add_cfn_init_proxy_props = AddCfnInitProxyProps(...)
Properties
| Name | Type | Description |
|---|---|---|
proxyHost |
string |
host of your proxy. |
proxyPort |
number |
proxy port. |
proxyCredentials |
aws-cdk-lib.aws_secretsmanager.ISecret |
JSON secret containing user and password properties to use if your proxy requires credentials http://user:password@host:port could contain sensitive data, so using a Secret. |
proxyType |
ProxyType |
Proxy Type. |
proxyHostRequired
# Example automatically generated from non-compiling source. May contain errors.
proxyHost: string;
- Type: string
host of your proxy.
Example
# Example automatically generated from non-compiling source. May contain errors.
example.com
proxyPortRequired
# Example automatically generated from non-compiling source. May contain errors.
proxyPort: number;
- Type: number
proxy port.
Example
8080
proxyCredentialsOptional
# Example automatically generated from non-compiling source. May contain errors.
proxyCredentials: ISecret;
- Type: aws-cdk-lib.aws_secretsmanager.ISecret
JSON secret containing user and password properties to use if your proxy requires credentials http://user:password@host:port could contain sensitive data, so using a Secret.
Note that while the user and password won't be visible in the cloudformation template
they will be in plain text inside your UserData
Example
# Example automatically generated from non-compiling source. May contain errors.
secret = Secret(stack, "TestSecret",
secret_object_value={
"user": SecretValue,
"password": SecretValue
}
)
proxyTypeOptional
# Example automatically generated from non-compiling source. May contain errors.
proxyType: ProxyType;
- Type: ProxyType
- Default: ProxyType.HTTP
Proxy Type.
Example
# Example automatically generated from non-compiling source. May contain errors.
ProxyType.HTTPS
AddPermissionBoundaryProps
Properties to pass to the AddPermissionBoundary.
Initializer
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import AddPermissionBoundaryProps
add_permission_boundary_props = AddPermissionBoundaryProps(...)
Properties
| Name | Type | Description |
|---|---|---|
permissionsBoundaryPolicyName |
string |
Name of Permissions Boundary Policy to add to all IAM roles. |
instanceProfilePrefix |
string |
A prefix to prepend to the name of the IAM InstanceProfiles (Default: ''). |
policyPrefix |
string |
A prefix to prepend to the name of the IAM Policies and ManagedPolicies (Default: ''). |
rolePrefix |
string |
A prefix to prepend to the name of IAM Roles (Default: ''). |
permissionsBoundaryPolicyNameRequired
# Example automatically generated from non-compiling source. May contain errors.
permissionsBoundaryPolicyName: string;
- Type: string
Name of Permissions Boundary Policy to add to all IAM roles.
instanceProfilePrefixOptional
# Example automatically generated from non-compiling source. May contain errors.
instanceProfilePrefix: string;
- Type: string
A prefix to prepend to the name of the IAM InstanceProfiles (Default: '').
policyPrefixOptional
# Example automatically generated from non-compiling source. May contain errors.
policyPrefix: string;
- Type: string
A prefix to prepend to the name of the IAM Policies and ManagedPolicies (Default: '').
rolePrefixOptional
# Example automatically generated from non-compiling source. May contain errors.
rolePrefix: string;
- Type: string
A prefix to prepend to the name of IAM Roles (Default: '').
EcsIsoServiceAutoscalerProps
Initializer
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import EcsIsoServiceAutoscalerProps
ecs_iso_service_autoscaler_props = EcsIsoServiceAutoscalerProps(...)
Properties
| Name | Type | Description |
|---|---|---|
ecsCluster |
aws-cdk-lib.aws_ecs.Cluster |
The cluster the service you wish to scale resides in. |
ecsService |
aws-cdk-lib.aws_ecs.IService |
The ECS service you wish to scale. |
scaleAlarm |
aws-cdk-lib.aws_cloudwatch.AlarmBase |
The Cloudwatch Alarm that will cause scaling actions to be invoked, whether it's in or not in alarm will determine scale up and down actions. |
maximumTaskCount |
number |
The maximum number of tasks that the service will scale out to. |
minimumTaskCount |
number |
The minimum number of tasks the service will have. |
role |
aws-cdk-lib.aws_iam.IRole |
Optional IAM role to attach to the created lambda to adjust the desired count on the ECS Service. |
scaleInCooldown |
aws-cdk-lib.Duration |
How long will the application wait before performing another scale in action. |
scaleInIncrement |
number |
The number of tasks that will scale in on scale in alarm status. |
scaleOutCooldown |
aws-cdk-lib.Duration |
How long will a the application wait before performing another scale out action. |
scaleOutIncrement |
number |
The number of tasks that will scale out on scale out alarm status. |
ecsClusterRequired
# Example automatically generated from non-compiling source. May contain errors.
ecsCluster: Cluster;
- Type: aws-cdk-lib.aws_ecs.Cluster
The cluster the service you wish to scale resides in.
ecsServiceRequired
# Example automatically generated from non-compiling source. May contain errors.
ecsService: IService;
- Type: aws-cdk-lib.aws_ecs.IService
The ECS service you wish to scale.
scaleAlarmRequired
# Example automatically generated from non-compiling source. May contain errors.
scaleAlarm: AlarmBase;
- Type: aws-cdk-lib.aws_cloudwatch.AlarmBase
The Cloudwatch Alarm that will cause scaling actions to be invoked, whether it's in or not in alarm will determine scale up and down actions.
Note: composite alarms can not be generated with CFN in all regions, while this allows you to pass in a composite alarm alarm creation is outside the scope of this construct
maximumTaskCountOptional
# Example automatically generated from non-compiling source. May contain errors.
maximumTaskCount: number;
- Type: number
- Default: 10
The maximum number of tasks that the service will scale out to.
Note: This does not provide any protection from scaling out above the maximum allowed in your account, set this variable and manage account quotas appropriately.
minimumTaskCountOptional
# Example automatically generated from non-compiling source. May contain errors.
minimumTaskCount: number;
- Type: number
- Default: 1
The minimum number of tasks the service will have.
roleOptional
# Example automatically generated from non-compiling source. May contain errors.
role: IRole;
- Type: aws-cdk-lib.aws_iam.IRole
- Default: A role is created for you with least privilege IAM policy
Optional IAM role to attach to the created lambda to adjust the desired count on the ECS Service.
Ensure this role has appropriate privileges. Example IAM policy statements:
{
"PolicyDocument": {
"Statement": [
{
"Action": "cloudwatch:DescribeAlarms",
"Effect": "Allow",
"Resource": "*"
},
{
"Action": [
"ecs:DescribeServices",
"ecs:UpdateService"
],
"Condition": {
"StringEquals": {
"ecs:cluster": "arn:${Partition}:ecs:${Region}:${Account}:cluster/${ClusterName}"
}
},
"Effect": "Allow",
"Resource": "arn:${Partition}:ecs:${Region}:${Account}:service/${ClusterName}/${ServiceName}"
}
],
"Version": "2012-10-17"
}
}
scaleInCooldownOptional
# Example automatically generated from non-compiling source. May contain errors.
scaleInCooldown: Duration;
- Type: aws-cdk-lib.Duration
- Default: 60 seconds
How long will the application wait before performing another scale in action.
scaleInIncrementOptional
# Example automatically generated from non-compiling source. May contain errors.
scaleInIncrement: number;
- Type: number
- Default: 1
The number of tasks that will scale in on scale in alarm status.
scaleOutCooldownOptional
# Example automatically generated from non-compiling source. May contain errors.
scaleOutCooldown: Duration;
- Type: aws-cdk-lib.Duration
- Default: 60 seconds
How long will a the application wait before performing another scale out action.
scaleOutIncrementOptional
# Example automatically generated from non-compiling source. May contain errors.
scaleOutIncrement: number;
- Type: number
- Default: 1
The number of tasks that will scale out on scale out alarm status.
PopulateWithConfigProps
Initializer
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import PopulateWithConfigProps
populate_with_config_props = PopulateWithConfigProps(...)
Properties
| Name | Type | Description |
|---|---|---|
localRouteTableId |
string |
Local route table ID, with routes only to local VPC. |
privateRouteTableId |
string |
Route table ID for a provided route table with routes to enterprise network. |
subnetConfig |
SubnetConfig[] |
List of Subnet configs to provision to provision. |
vpcId |
string |
ID of the VPC provided that needs to be populated. |
localRouteTableIdRequired
# Example automatically generated from non-compiling source. May contain errors.
localRouteTableId: string;
- Type: string
Local route table ID, with routes only to local VPC.
privateRouteTableIdRequired
# Example automatically generated from non-compiling source. May contain errors.
privateRouteTableId: string;
- Type: string
Route table ID for a provided route table with routes to enterprise network.
Both subnetType.PUBLIC and subnetType.PRIVATE_WITH_EGRESS will use this property
subnetConfigRequired
# Example automatically generated from non-compiling source. May contain errors.
subnetConfig: SubnetConfig[];
- Type: SubnetConfig[]
List of Subnet configs to provision to provision.
vpcIdRequired
# Example automatically generated from non-compiling source. May contain errors.
vpcId: string;
- Type: string
ID of the VPC provided that needs to be populated.
RemoveTagsProps
Initializer
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import RemoveTagsProps
remove_tags_props = RemoveTagsProps(...)
Properties
| Name | Type | Description |
|---|---|---|
cloudformationResource |
string |
Name of Cloudformation resource Type (e.g. 'AWS::Lambda::Function'). |
tagPropertyName |
string |
Name of the tag property to remove from the resource. |
cloudformationResourceRequired
# Example automatically generated from non-compiling source. May contain errors.
cloudformationResource: string;
- Type: string
Name of Cloudformation resource Type (e.g. 'AWS::Lambda::Function').
tagPropertyNameOptional
# Example automatically generated from non-compiling source. May contain errors.
tagPropertyName: string;
- Type: string
- Default: Tags
Name of the tag property to remove from the resource.
ResourceExtractorProps
Initializer
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import ResourceExtractorProps
resource_extractor_props = ResourceExtractorProps(...)
Properties
| Name | Type | Description |
|---|---|---|
extractDestinationStack |
aws-cdk-lib.Stack |
Stack to move found extracted resources into. |
resourceTypesToExtract |
string[] |
List of resource types to extract, ex: AWS::IAM::Role. |
stackArtifacts |
aws-cdk-lib.cx_api.CloudFormationStackArtifact[] |
Synthed stack artifacts from your CDK app. |
additionalTransforms |
{[ key: string ]: string} |
Additional resource transformations. |
valueShareMethod |
ResourceExtractorShareMethod |
The sharing method to use when passing exported resources from the "Extracted Stack" into the original stack(s). |
extractDestinationStackRequired
extractDestinationStack: Stack;
- Type: aws-cdk-lib.Stack
Stack to move found extracted resources into.
resourceTypesToExtractRequired
# Example automatically generated from non-compiling source. May contain errors.
resourceTypesToExtract: string[];
- Type: string[]
List of resource types to extract, ex: AWS::IAM::Role.
stackArtifactsRequired
# Example automatically generated from non-compiling source. May contain errors.
stackArtifacts: CloudFormationStackArtifact[];
- Type: aws-cdk-lib.cx_api.CloudFormationStackArtifact[]
Synthed stack artifacts from your CDK app.
additionalTransformsOptional
# Example automatically generated from non-compiling source. May contain errors.
additionalTransforms: {[ key: string ]: string}
- Type: {[ key: string ]: string}
Additional resource transformations.
valueShareMethodOptional
# Example automatically generated from non-compiling source. May contain errors.
valueShareMethod: ResourceExtractorShareMethod;
The sharing method to use when passing exported resources from the "Extracted Stack" into the original stack(s).
SetApiGatewayEndpointConfigurationProps
Initializer
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import SetApiGatewayEndpointConfigurationProps
set_api_gateway_endpoint_configuration_props = SetApiGatewayEndpointConfigurationProps(...)
Properties
| Name | Type | Description |
|---|---|---|
endpointType |
aws-cdk-lib.aws_apigateway.EndpointType |
API Gateway endpoint type to override to. |
endpointTypeOptional
# Example automatically generated from non-compiling source. May contain errors.
endpointType: EndpointType;
- Type: aws-cdk-lib.aws_apigateway.EndpointType
- Default: EndpointType.REGIONAL
API Gateway endpoint type to override to.
Defaults to EndpointType.REGIONAL
SplitVpcEvenlyProps
Initializer
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import SplitVpcEvenlyProps
split_vpc_evenly_props = SplitVpcEvenlyProps(...)
Properties
| Name | Type | Description |
|---|---|---|
routeTableId |
string |
Route Table ID that will be attached to each subnet created. |
vpcCidr |
string |
CIDR range of the VPC you're populating. |
vpcId |
string |
ID of the existing VPC you're trying to populate. |
cidrBits |
string |
cidrBits argument for the Fn::Cidr Cloudformation intrinsic function. |
numberOfAzs |
number |
Number of AZs to evenly split into. |
subnetType |
aws-cdk-lib.aws_ec2.SubnetType |
No description. |
routeTableIdRequired
# Example automatically generated from non-compiling source. May contain errors.
routeTableId: string;
- Type: string
Route Table ID that will be attached to each subnet created.
vpcCidrRequired
# Example automatically generated from non-compiling source. May contain errors.
vpcCidr: string;
- Type: string
CIDR range of the VPC you're populating.
vpcIdRequired
# Example automatically generated from non-compiling source. May contain errors.
vpcId: string;
- Type: string
ID of the existing VPC you're trying to populate.
cidrBitsOptional
# Example automatically generated from non-compiling source. May contain errors.
cidrBits: string;
- Type: string
- Default: '6'
cidrBits argument for the Fn::Cidr Cloudformation intrinsic function.
numberOfAzsOptional
# Example automatically generated from non-compiling source. May contain errors.
numberOfAzs: number;
- Type: number
- Default: 3
Number of AZs to evenly split into.
subnetTypeOptional
# Example automatically generated from non-compiling source. May contain errors.
subnetType: SubnetType;
- Type: aws-cdk-lib.aws_ec2.SubnetType
- Default: subnetType.PRIVATE
SubnetConfig
Initializer
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import SubnetConfig
subnet_config = SubnetConfig(...)
Properties
| Name | Type | Description |
|---|---|---|
availabilityZone |
string |
Which availability zone the subnet should be in. |
cidrRange |
string |
Cidr range of the subnet to create. |
groupName |
string |
Logical group name of a subnet. |
subnetType |
aws-cdk-lib.aws_ec2.SubnetType |
What SubnetType to use. |
availabilityZoneRequired
# Example automatically generated from non-compiling source. May contain errors.
availabilityZone: string;
- Type: string
Which availability zone the subnet should be in.
cidrRangeRequired
# Example automatically generated from non-compiling source. May contain errors.
cidrRange: string;
- Type: string
Cidr range of the subnet to create.
groupNameRequired
# Example automatically generated from non-compiling source. May contain errors.
groupName: string;
- Type: string
Logical group name of a subnet.
Example
# Example automatically generated from non-compiling source. May contain errors.
db
subnetTypeRequired
# Example automatically generated from non-compiling source. May contain errors.
subnetType: SubnetType;
- Type: aws-cdk-lib.aws_ec2.SubnetType
What SubnetType to use.
This will govern the aws-cdk:subnet-type tag on the subnet
| SubnetType | aws-cdk:subnet-type tag value |
|---|---|
PRIVATE_ISOLATED |
'Isolated' |
PRIVATE_WITH_EGRESS |
'Private' |
PUBLIC |
'Public' |
Classes
AddCfnInitProxy
- Implements: aws-cdk-lib.IAspect
Add proxy configuration to Cloudformation helper functions.
Initializers
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import AddCfnInitProxy
AddCfnInitProxy(props, AddCfnInitProxyProps)
| Name | Type | Description |
|---|---|---|
props |
AddCfnInitProxyProps |
No description. |
propsRequired
- Type: AddCfnInitProxyProps
Methods
| Name | Description |
|---|---|
visit |
All aspects can visit an IConstruct. |
visit
# Example automatically generated from non-compiling source. May contain errors.
visit(node, IConstruct)
All aspects can visit an IConstruct.
nodeRequired
- Type: constructs.IConstruct
AddLambdaEnvironmentVariables
- Implements: aws-cdk-lib.IAspect
Add one or more environment variables to all lambda functions within a scope.
Initializers
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import AddLambdaEnvironmentVariables
AddLambdaEnvironmentVariables(props, {"key": string, "string": string})
| Name | Type | Description |
|---|---|---|
props |
{[ key: string ]: string} |
: string} props - Key Value pair(s) for environment variables to add to all lambda functions. |
propsRequired
- Type: {[ key: string ]: string}
: string} props - Key Value pair(s) for environment variables to add to all lambda functions.
Methods
| Name | Description |
|---|---|
visit |
All aspects can visit an IConstruct. |
visit
# Example automatically generated from non-compiling source. May contain errors.
visit(node, IConstruct)
All aspects can visit an IConstruct.
nodeRequired
- Type: constructs.IConstruct
AddPermissionBoundary
- Implements: aws-cdk-lib.IAspect
A patch for Adding Permissions Boundaries to all IAM roles.
Additional options for adding prefixes to IAM role, policy and instance profile names
Can account for non commercial partitions (e.g. aws-gov, aws-cn)
Initializers
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import AddPermissionBoundary
AddPermissionBoundary(props, AddPermissionBoundaryProps)
| Name | Type | Description |
|---|---|---|
props |
AddPermissionBoundaryProps |
No description. |
propsRequired
Methods
| Name | Description |
|---|---|
checkAndOverride |
No description. |
visit |
All aspects can visit an IConstruct. |
checkAndOverride
# Example automatically generated from non-compiling source. May contain errors.
check_and_override(node, CfnResource, prefix, string, length, number, cfn_prop, string, cdkProp?: string)
nodeRequired
- Type: aws-cdk-lib.CfnResource
prefixRequired
- Type: string
lengthRequired
- Type: number
cfnPropRequired
- Type: string
cdkPropOptional
- Type: string
visit
# Example automatically generated from non-compiling source. May contain errors.
visit(node, IConstruct)
All aspects can visit an IConstruct.
nodeRequired
- Type: constructs.IConstruct
ConvertInlinePoliciesToManaged
- Implements: aws-cdk-lib.IAspect
Patch for turning all Policies into ConvertInlinePoliciesToManaged.
Some users have policies in place that make it impossible to create inline policies. Instead, they must use managed policies.
Note that order matters with this aspect. Specifically, it should generally be added first. This is because other aspects may add overrides that would be lost if applied before this aspect since the original aspect is removed and replaced.
Example
# Example automatically generated from non-compiling source. May contain errors.
# Replace all AWS::IAM::Policy resources with equivalent AWS::IAM::ManagedPolicy
Aspects.of(stack).add(ConvertInlinePoliciesToManaged())
Initializers
from cdklabs.cdk_enterprise_iac import ConvertInlinePoliciesToManaged
ConvertInlinePoliciesToManaged()
| Name | Type | Description |
|---|
Methods
| Name | Description |
|---|---|
visit |
All aspects can visit an IConstruct. |
visit
# Example automatically generated from non-compiling source. May contain errors.
visit(node, IConstruct)
All aspects can visit an IConstruct.
nodeRequired
- Type: constructs.IConstruct
RemovePublicAccessBlockConfiguration
- Implements: aws-cdk-lib.IAspect
Looks for S3 Buckets, and removes the PublicAccessBlockConfiguration property.
For use in regions where Cloudformation doesn't support this property
Initializers
from cdklabs.cdk_enterprise_iac import RemovePublicAccessBlockConfiguration
RemovePublicAccessBlockConfiguration()
| Name | Type | Description |
|---|
Methods
| Name | Description |
|---|---|
visit |
All aspects can visit an IConstruct. |
visit
# Example automatically generated from non-compiling source. May contain errors.
visit(node, IConstruct)
All aspects can visit an IConstruct.
nodeRequired
- Type: constructs.IConstruct
RemoveTags
- Implements: aws-cdk-lib.IAspect
Patch for removing tags from a specific Cloudformation Resource.
In some regions, the 'Tags' property isn't supported in Cloudformation. This patch makes it easy to remove
Example
# Example automatically generated from non-compiling source. May contain errors.
# Remove tags on a resource
Aspects.of(stack).add(RemoveTags(
cloudformation_resource="AWS::ECS::Cluster"
))
# Remove tags without the standard 'Tags' name
Aspects.of(stack).add(RemoveTags(
cloudformation_resource="AWS::Backup::BackupPlan",
tag_property_name="BackupPlanTags"
))
Initializers
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import RemoveTags
RemoveTags(props, RemoveTagsProps)
| Name | Type | Description |
|---|---|---|
props |
RemoveTagsProps |
No description. |
propsRequired
- Type: RemoveTagsProps
Methods
| Name | Description |
|---|---|
visit |
All aspects can visit an IConstruct. |
visit
# Example automatically generated from non-compiling source. May contain errors.
visit(node, IConstruct)
All aspects can visit an IConstruct.
nodeRequired
- Type: constructs.IConstruct
ResourceExtractor
- Implements: aws-cdk-lib.IAspect
This Aspect takes a CDK application, all synthesized CloudFormationStackArtifact, a value share method, and a list of Cloudformation resources that should be pulled out of the main CDK application, which should be synthesized to a cloudformation template that an external team (e.g. security team) to deploy, and adjusting the CDK application to reference pre-created resources already pulled out.
Example
# Example automatically generated from non-compiling source. May contain errors.
app = App()
stack = Stack(app, "MyStack")
extracted_stack = Stack(app, "ExtractedStack")
synthed_app = app.synth()
Aspects.of(app).add(ResourceExtractor(
extract_destination_stack=extracted_stack,
stack_artifacts=synthed_app.stacks,
value_share_method=ResourceExtractorShareMethod.CFN_OUTPUT,
resource_types_to_extract=["AWS::IAM::Role", "AWS::IAM::Policy", "AWS::IAM::ManagedPolicy", "AWS::IAM::InstanceProfile"
]
))
app.synth(force=True)
Initializers
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import ResourceExtractor
ResourceExtractor(props, ResourceExtractorProps)
| Name | Type | Description |
|---|---|---|
props |
ResourceExtractorProps |
No description. |
propsRequired
- Type: ResourceExtractorProps
Methods
| Name | Description |
|---|---|
visit |
Entrypoint. |
visit
# Example automatically generated from non-compiling source. May contain errors.
visit(node, IConstruct)
Entrypoint.
nodeRequired
- Type: constructs.IConstruct
SetApiGatewayEndpointConfiguration
- Implements: aws-cdk-lib.IAspect
Override RestApis to use a set endpoint configuration.
Some regions don't support EDGE endpoints, and some enterprises require specific endpoint types for RestApis
Initializers
# Example automatically generated from non-compiling source. May contain errors.
from cdklabs.cdk_enterprise_iac import SetApiGatewayEndpointConfiguration
SetApiGatewayEndpointConfiguration(props?: SetApiGatewayEndpointConfigurationProps)
| Name | Type | Description |
|---|---|---|
props |
SetApiGatewayEndpointConfigurationProps |
No description. |
propsOptional
Methods
| Name | Description |
|---|---|
visit |
All aspects can visit an IConstruct. |
visit
# Example automatically generated from non-compiling source. May contain errors.
visit(node, IConstruct)
All aspects can visit an IConstruct.
nodeRequired
- Type: constructs.IConstruct
Enums
ProxyType
Whether an http-proxy or https-proxy.
Members
| Name | Description |
|---|---|
HTTP |
--http-proxy. |
HTTPS |
--https-proxy. |
HTTP
-http-proxy.
HTTPS
-https-proxy.
ResourceExtractorShareMethod
The available value sharing methods to pass values from the extracted stack onto the original stack(s).
Members
| Name | Description |
|---|---|
CFN_OUTPUT |
No description. |
SSM_PARAMETER |
No description. |
API_LOOKUP |
No description. |
CFN_OUTPUT
SSM_PARAMETER
API_LOOKUP
ResourceTransform
Members
| Name | Description |
|---|---|
STACK_NAME |
No description. |
LOGICAL_ID |
No description. |
STACK_NAME
LOGICAL_ID
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cdklabs.cdk-enterprise-iac-0.0.419.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | abe65eb0fce4dce69ae1f996f9ef08e54284e457816d9cc08ebf5c86301acc7b |
|
| MD5 | 3da9df6d4fbd4f2179177ae0ea5f5ce9 |
|
| BLAKE2b-256 | 0ccd24ef2ce772488cec8d81ef49a98164e6edd495f0953eebc75280cbb5fc7c |
Hashes for cdklabs.cdk_enterprise_iac-0.0.419-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | db7fd7f9efd52513fad0f4e4dceb0c931c8f8543c7d2ab14025043c7fcb6ef63 |
|
| MD5 | be0cdf9e9e73b7f8e0489894ef49bb3c |
|
| BLAKE2b-256 | 5f1fda97bc09c11ca3ae7790aeaf96e29e27594ca058540508e261041deda619 |
