Este é o Guia do desenvolvedor do AWS CDK v2. O CDK v1 antigo entrou em manutenção em 1º de junho de 2022 e encerrou o suporte em 1º de junho de 2023.

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Configuração de constructos com Esquemas do CDK

Use os Esquemas do AWS CDK para padronizar e distribuir configurações do constructo L2 em toda a sua organização. Com os Esquemas, é possível garantir que os recursos da AWS sejam configurados de forma consistente de acordo com seus padrões organizacionais e práticas recomendadas. Por exemplo, é possível habilitar automaticamente a criptografia para todos os buckets do Amazon S3, aplicar configurações de registro em log específicas a todas as funções do AWS Lambda ou aplicar regras de segurança padrão para todos os grupos de segurança.

Os Esquemas são alimentados pela injeção de propriedades, um mecanismo introduzido no AWS CDK v2.196.0 que permite modificar as propriedades do constructo no momento da instanciação. Um Esquema é uma coleção de injetores de propriedades, em que cada injetor de propriedades especifica a configuração ideal para um constructo L2 específico. O Esquema representa as práticas recomendas gerais para sua organização.

Os Esquemas não são um mecanismo de fiscalização da conformidade. Os desenvolvedores ainda podem ignorar os padrões, se necessário. Para uma fiscalização rigorosa da conformidade, considere usar o AWS CloudFormation Guard, as Políticas de controle de serviços ou o CDK Aspects, além dos Esquemas.

Para obter informações detalhadas sobre a implementação, consulte a RFC sobre injeção de propriedades.

Principais componentes dos Esquemas

Os Esquemas são coleções de injetores de propriedades que aplicam propriedades padrão aos constructos quando eles são instanciados. Um injetor de propriedades é um componente que implementa a interface IPropertyInjector, que intercepta a criação do constructo e modifica ou adiciona propriedades antes que o constructo seja criado.

Casos de uso comuns para os Esquemas.

É possível usar os Esquemas do CDK para padronizar muitos aspectos dos seus recursos da AWS. Aqui estão alguns casos de uso comuns:

Conceitos básicos dos Esquemas

Veja a seguir um exemplo simples de como criar e usar um injetor de propriedades:

Primeiro, crie um injetor de propriedades para os buckets do Amazon S3:

import { IPropertyInjector, InjectionContext } from 'aws-cdk-lib';
import { Bucket, BucketProps, BlockPublicAccess } from 'aws-cdk-lib/aws-s3';

export class SecureBucketDefaults implements IPropertyInjector {
  public readonly constructUniqueId: string;

  constructor() {
    this.constructUniqueId = Bucket.PROPERTY_INJECTION_ID;
  }

  public inject(originalProps: BucketProps, _context: InjectionContext): BucketProps {
    return {
      // Set security defaults
      blockPublicAccess: BlockPublicAccess.BLOCK_ALL,
      enforceSSL: true,

      // Include original props to allow overrides
      ...originalProps,
    };
  }
}

Em seguida, use o injetor em sua aplicação do CDK:

import { App, Stack } from 'aws-cdk-lib';
import { Bucket } from 'aws-cdk-lib/aws-s3';
import { SecureBucketDefaults } from './secure-bucket-defaults';

// Attach injectors when creating the App
const app = new App({
  propertyInjectors: [new SecureBucketDefaults()]
});

const stack = new Stack(app, 'MyStack');

// This bucket automatically gets the default properties
const myBucket = new Bucket(stack, 'MyBucket');

De forma alternativa, é possível usar o método PropertyInjectors.of():

import { App, Stack, PropertyInjectors } from 'aws-cdk-lib';
import { SecureBucketDefaults } from './secure-bucket-defaults';

const app = new App();
PropertyInjectors.of(app).add(new SecureBucketDefaults());

const stack = new Stack(app, 'MyStack');
const myBucket = new Bucket(stack, 'MyBucket');

Práticas recomendadas

Para obter informações mais detalhadas sobre a injeção de propriedades, incluindo detalhes de implementação, dicas de solução de problemas e informações de referência, consulte a RFC de injeção de propriedades.