API 参考

构造

EcsIso 服务自动缩放器

创建 EcsIsoService自动缩放构建.

此构造允许您在 ISO 中缩放 ECS 服务 区域中可能无法提供经典ECS自动缩放.

初始化剂

import { EcsIsoServiceAutoscaler } from '@cdklabs/cdk-enterprise-iac'

new EcsIsoServiceAutoscaler(scope: Construct, id: string, props: EcsIsoServiceAutoscalerProps)

scope^需求

• 类型 : 构造 构造

id^需求

• 类型 : 字符串

props^需求

• 类型 : EcsIso 服务自动缩放程序

方法

toString

public toString(): string

返回此构造的字符串表达式 .

静态函数

isConstruct

import { EcsIsoServiceAutoscaler } from '@cdklabs/cdk-enterprise-iac'

EcsIsoServiceAutoscaler.isConstruct(x: any)

检查是否 x 是一个构造.

x^需求

• 类型 : 任意

任何物体.

属性

node^需求

public readonly node: Node;

• 类型 : 构造 节点

树节.

ecsScalingManagerFunction^需求

public readonly ecsScalingManagerFunction: Function;

• 类型 : aws-cdk-lib.aws lambda (英语). 函数

以配置填充

输入一个基于所提供配置的 VPC 子网.

示例

const mySubnetConfig: SubnetConfig[] = [
   {
     groupName: 'app',
     cidrRange: '172.31.0.0/27',
     availabilityZone: 'a',
     subnetType: subnetType.PUBLIC,
   },
   {
     groupName: 'app',
     cidrRange: '172.31.0.32/27',
     availabilityZone: 'b',
     subnetType: subnetType.PUBLIC,
   },
   {
     groupName: 'db',
     cidrRange: '172.31.0.64/27',
     availabilityZone: 'a',
     subnetType: subnetType.PRIVATE_WITH_EGRESS,
   },
   {
     groupName: 'db',
     cidrRange: '172.31.0.96/27',
     availabilityZone: 'b',
     subnetType: subnetType.PRIVATE_WITH_EGRESS,
   },
   {
     groupName: 'iso',
     cidrRange: '172.31.0.128/26',
     availabilityZone: 'a',
     subnetType: subnetType.PRIVATE_ISOLATED,
   },
   {
     groupName: 'iso',
     cidrRange: '172.31.0.196/26',
     availabilityZone: 'b',
     subnetType: subnetType.PRIVATE_ISOLATED,
   },
 ];
new PopulateWithConfig(this, "vpcPopulater", {
  vpcId: 'vpc-abcdefg1234567',
  privateRouteTableId: 'rt-abcdefg123456',
  localRouteTableId: 'rt-123456abcdefg',
  subnetConfig: mySubnetConfig,
})

初始化剂

import { PopulateWithConfig } from '@cdklabs/cdk-enterprise-iac'

new PopulateWithConfig(scope: Construct, id: string, props: PopulateWithConfigProps)

scope^需求

• 类型 : 构造 构造

id^需求

• 类型 : 字符串

props^需求

• 类型 : 使用配置配置

方法

toString

public toString(): string

返回此构造的字符串表达式 .

静态函数

isConstruct

import { PopulateWithConfig } from '@cdklabs/cdk-enterprise-iac'

PopulateWithConfig.isConstruct(x: any)

检查是否 x 是一个构造.

x^需求

• 类型 : 任意

任何物体.

属性

node^需求

public readonly node: Node;

• 类型 : 构造 节点

树节.

分割 Vpc 偶数

将一个 VPC 平分到一个指定的 AZ 数( 如果没有定义 ) 之间, 并附上一个指定的路由表和标签 .

示例

// with more specific properties
new SplitVpcEvenly(this, 'evenSplitVpc', {
  vpcId: 'vpc-abcdefg123456',
  vpcCidr: '172.16.0.0/16',
  routeTableId: 'rt-abcdefgh123456',
  cidrBits: '10',
  numberOfAzs: 4,
  subnetType: subnetType.PRIVATE_ISOLATED,
});

初始化剂

import { SplitVpcEvenly } from '@cdklabs/cdk-enterprise-iac'

new SplitVpcEvenly(scope: Construct, id: string, props: SplitVpcEvenlyProps)

scope^需求

• 类型 : 构造 构造

id^需求

• 类型 : 字符串

props^需求

• 类型 : 分割 VpcEvenly 程序

方法

toString

public toString(): string

返回此构造的字符串表达式 .

静态函数

isConstruct

import { SplitVpcEvenly } from '@cdklabs/cdk-enterprise-iac'

SplitVpcEvenly.isConstruct(x: any)

检查是否 x 是一个构造.

x^需求

• 类型 : 任意

任何物体.

属性

node^需求

public readonly node: Node;

• 类型 : 构造 节点

树节.

字符串

添加Cfninit Proxy 软件

代理服务器使用 Cfn 帮助命令的属性 .

初始化器

import { AddCfnInitProxyProps } from '@cdklabs/cdk-enterprise-iac'

const addCfnInitProxyProps: AddCfnInitProxyProps = { ... }

属性

proxyHost^需求

public readonly proxyHost: string;

• 类型 : 字符串

您代理服务器的主机 .

示例

example.com

proxyPort^需求

public readonly proxyPort: number;

• 类型 : 编号

代理端口 .

示例

8080

proxyCredentials^可选

public readonly proxyCredentials: ISecret;

• 类型 : aws-cdk-lib.aws secretsmanager.ISecret (英语)

包含 user 财务报告和审定财务报表 password 如果代理机需要证书, 属性将使用 http://user:password@host:port 可能包含敏感数据, 所以使用一个秘密.

请注意,虽然 user 财务报告和审定财务报表 password 在云形模板中看不到 他们 将 以简洁的文字在您体内 UserData

示例

const secret = new Secret(stack, 'TestSecret', {
 secretObjectValue: {
   user: SecretValue,
   password: SecretValue,
 },
});

proxyType^可选

public readonly proxyType: ProxyType;

• 类型 : 代理服务器
• 默认 : 代理服务器. HTTP

代理类型.

示例

ProxyType.HTTPS

添加任务界限

传递给添加边界的属性 .

初始化器

import { AddPermissionBoundaryProps } from '@cdklabs/cdk-enterprise-iac'

const addPermissionBoundaryProps: AddPermissionBoundaryProps = { ... }

属性

permissionsBoundaryPolicyName^需求

public readonly permissionsBoundaryPolicyName: string;

• 类型 : 字符串

许可边界政策名称,以添加所有IAM角色.

instanceProfilePrefix^可选

public readonly instanceProfilePrefix: string;

• 类型 : 字符串

IAM IntextProfiles (Default: '') 名称的前缀 .

policyPrefix^可选

public readonly policyPrefix: string;

• 类型 : 字符串

IAM 政策和管理政策名称前缀(默认:"'").

rolePrefix^可选

public readonly rolePrefix: string;

• 类型 : 字符串

一个预置到IAM角色(Default:"'")名称的前缀.

EcsIso 服务自动缩放程序

初始化器

import { EcsIsoServiceAutoscalerProps } from '@cdklabs/cdk-enterprise-iac'

const ecsIsoServiceAutoscalerProps: EcsIsoServiceAutoscalerProps = { ... }

属性

ecsCluster^需求

public readonly ecsCluster: Cluster;

• 类型 : aws-cdk-lib.aws ecs. (原始内容存档于2018-10-12). 组

您想要扩展的服务所在的集群 .

ecsService^需求

public readonly ecsService: IService;

• 类型 : aws-cdk-lib.aws ecs.IService (英语)

您想要扩展的ECS服务 .

scaleAlarm^需求

public readonly scaleAlarm: AlarmBase;

• 类型 : aws-cdk-lib.aws cloudwatch. (原始内容存档于2018-09-27). 提醒库

云表警报会引发规模化动作的被引用,无论它是否处于警报状态,都会决定规模上下动作.

注意: 综合提醒无法在所有地区与 CFN 一起生成, 而允许您在综合提醒创建中通过, 不属于此构造的范围

maximumTaskCount^可选

public readonly maximumTaskCount: number;

• 类型 : 编号
• 默认 : 10个

服务将扩展至的最大任务数 .

说明: 这并不能防止超出您账户允许的上限、设置该变量并适当管理账户配额.

minimumTaskCount^可选

public readonly minimumTaskCount: number;

• 类型 : 编号
• 默认 : 1个

服务将承担的最低任务数 .

role^可选

public readonly role: IRole;

• 类型 : aws-cdk-lib.aws iam (英语). 内弹
• 默认 : 给您创造了一个角色 以最小的特权IAM政策

可选的IAM角色附在所创建的Lambda上以调整ECS服务所期望的计数.

确保这一作用具有适当的特权。 实例IAM政策声明:

{
  "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"
  }
}

scaleInCooldown^可选

public readonly scaleInCooldown: Duration;

• 类型 : aws-cdk-lib (英语). 会期
• 默认 : 60秒钟

申请要等多久才能执行另一个行动尺度.

scaleInIncrement^可选

public readonly scaleInIncrement: number;

• 类型 : 编号
• 默认 : 1个

在提醒状态下规模化的任务数量 .

scaleOutCooldown^可选

public readonly scaleOutCooldown: Duration;

• 类型 : aws-cdk-lib (英语). 会期
• 默认 : 60秒钟

应用程序要等多久才能执行另一个缩放动作 .

scaleOutIncrement^可选

public readonly scaleOutIncrement: number;

• 类型 : 编号
• 默认 : 1个

规模化的提醒状态任务数量 .

使用配置配置

初始化器

import { PopulateWithConfigProps } from '@cdklabs/cdk-enterprise-iac'

const populateWithConfigProps: PopulateWithConfigProps = { ... }

属性

localRouteTableId^需求

public readonly localRouteTableId: string;

• 类型 : 字符串

本地路由表ID,线路仅通向当地VPC.

privateRouteTableId^需求

public readonly privateRouteTableId: string;

• 类型 : 字符串

附有通往企业网络的路线的路线表的路由表ID.

双子网Type.PUBLIC和子网Type.PRIVATE WITH EGRESS将使用此属性

subnetConfig^需求

public readonly subnetConfig: SubnetConfig[];

• 类型 : 子网连接[

子网配置列表,用于提供.

vpcId^需求

public readonly vpcId: string;

• 类型 : 字符串

人身保护局的身份证规定需要有人居住.

删除标签

初始化器

import { RemoveTagsProps } from '@cdklabs/cdk-enterprise-iac'

const removeTagsProps: RemoveTagsProps = { ... }

属性

cloudformationResource^需求

public readonly cloudformationResource: string;

• 类型 : 字符串

云形资源类型的名称(例如"AWS:Lambda::Function").

tagPropertyName^可选

public readonly tagPropertyName: string;

• 类型 : 字符串
• 默认 : 标记

要从资源中删除的标签属性名称 .

资源外传程序

初始化器

import { ResourceExtractorProps } from '@cdklabs/cdk-enterprise-iac'

const resourceExtractorProps: ResourceExtractorProps = { ... }

属性

extractDestinationStack^需求

public readonly extractDestinationStack: Stack;

• 类型 : aws-cdk-lib (英语). 堆栈

堆栈可移动已找到的提取资源 .

resourceTypesToExtract^需求

public readonly resourceTypesToExtract: string[];

• 类型 : 字符串 []

要提取的资源类型列表, 如 : AWS::IAM::Role。 。 。 .

stackArtifacts^需求

public readonly stackArtifacts: CloudFormationStackArtifact[];

• 类型 : aws-cdk-lib.cx api. CloudFormation StackArtifact[] 互联网档案馆的存檔,存档日期2013-12-21

从你的CDK应用程序合成的堆栈文物.

additionalTransforms^可选

public readonly additionalTransforms: {[ key: string ]: string};

• 类型 : {[键:字符串]:字符串}

额外资源转型.

valueShareMethod^可选

public readonly valueShareMethod: ResourceExtractorShareMethod;

• 类型 : 资源Extractor 共享方法

将“ Extraded Stack” 输出资源传递到原始堆栈时使用的共享方法 .

设置 ApiGateway 终端配置

初始化器

import { SetApiGatewayEndpointConfigurationProps } from '@cdklabs/cdk-enterprise-iac'

const setApiGatewayEndpointConfigurationProps: SetApiGatewayEndpointConfigurationProps = { ... }

属性

endpointType^可选

public readonly endpointType: EndpointType;

• 类型 : aws-cdk-lib.aws apigateway. EndpointType (英语)
• 默认 : 端点Type.区域

API Gateway 端点类型要覆盖到 .

默认为 EndpointType.regional

分割 VpcEvenly 程序

初始化器

import { SplitVpcEvenlyProps } from '@cdklabs/cdk-enterprise-iac'

const splitVpcEvenlyProps: SplitVpcEvenlyProps = { ... }

属性

routeTableId^需求

public readonly routeTableId: string;

• 类型 : 字符串

将附加到每个子网的路由表 ID .

vpcCidr^需求

public readonly vpcCidr: string;

• 类型 : 字符串

CIDR的VPC范围 你正在流行.

vpcId^需求

public readonly vpcId: string;

• 类型 : 字符串

你试图填充的VPC的ID.

cidrBits^可选

public readonly cidrBits: string;

• 类型 : 字符串
• 默认 : 六号

cidrBits 参数 Fn::Cidr 云形内在功能.

数字