Etiquetado - AWS Cloud Development Kit (AWS CDK) v2
Uso de etiquetasPrioridades de etiquetasPropiedades opcionalesEjemploEtiquetar construcciones individuales

Esta es la guía para AWS CDK desarrolladores de la versión 2. La versión anterior del CDK v1 entró en mantenimiento el 1 de junio de 2022 y dejó de ofrecer soporte el 1 de junio de 2023.

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Etiquetado

Las etiquetas son elementos clave-valor informativos que puedes agregar a las construcciones de tu aplicación. AWS CDK Una etiqueta aplicada a una construcción determinada también se aplica a todos sus elementos secundarios etiquetables. Las etiquetas se incluyen en la AWS CloudFormation plantilla sintetizada a partir de la aplicación y se aplican a los AWS recursos que implementa. Puedes usar etiquetas para identificar y clasificar los recursos con los siguientes fines:

  • Simplificar la administración

  • Asignación de costos

  • Control de acceso

  • ¿Algún otro propósito que se proponga

sugerencia

Para obtener más información sobre cómo utilizar las etiquetas con AWS los recursos, consulte las prácticas recomendadas para etiquetar AWS los recursos en el AWS documento técnico.

Uso de etiquetas

La Tagsclase incluye el método estáticoof(), mediante el cual puede añadir o eliminar etiquetas de la construcción especificada.

  • Tags.of(SCOPE).add()aplica una nueva etiqueta a la construcción dada y a todos sus elementos secundarios.

  • Tags.of(SCOPE).remove()elimina una etiqueta de la construcción dada y de cualquiera de sus elementos secundarios, incluidas las etiquetas que una construcción secundaria pueda haberse aplicado a sí misma.

nota

El etiquetado se implementa medianteAspectos. Los aspectos son una forma de aplicar una operación (como el etiquetado) a todos los constructos de un ámbito determinado.

El siguiente ejemplo aplica la clave de etiqueta con el valor del valor a una construcción.

TypeScript
Tags.of(myConstruct).add('key', 'value');
JavaScript
Tags.of(myConstruct).add('key', 'value');
Python
Tags.of(my_construct).add("key", "value")
Java
Tags.of(myConstruct).add("key", "value");
C#
Tags.Of(myConstruct).Add("key", "value");
Go
awscdk.Tags_Of(myConstruct).Add(jsii.String("key"), jsii.String("value"), &awscdk.TagProps{})

En el siguiente ejemplo, se elimina la clave de etiqueta de una construcción.

TypeScript
Tags.of(myConstruct).remove('key');
JavaScript
Tags.of(myConstruct).remove('key');
Python
Tags.of(my_construct).remove("key")
Java
Tags.of(myConstruct).remove("key");
C#
Tags.Of(myConstruct).Remove("key");
Go
awscdk.Tags_Of(myConstruct).Remove(jsii.String("key"), &awscdk.TagProps{})

Si utiliza Stage componentes fijos, aplique la etiqueta en el Stage nivel o por debajo. Las etiquetas no se aplican a través de Stage los límites.

Prioridades de etiquetas

AWS CDK Aplica y elimina las etiquetas de forma recursiva. Si hay conflictos, gana la operación de etiquetado con la prioridad más alta. (Las prioridades se establecen mediante la priority propiedad opcional). Si las prioridades de dos operaciones son las mismas, gana la operación de etiquetado que se encuentre más cerca de la parte inferior del árbol de construcción. De forma predeterminada, aplicar una etiqueta tiene una prioridad de 100 (excepto en el caso de las etiquetas que se añaden directamente a un AWS CloudFormation recurso, que tienen una prioridad de 50). La prioridad predeterminada para eliminar una etiqueta es 200.

A continuación se aplica una etiqueta con una prioridad de 300 a un componente fijo.

TypeScript
Tags.of(myConstruct).add('key', 'value', {
  priority: 300
});
JavaScript
Tags.of(myConstruct).add('key', 'value', {
  priority: 300
});
Python
Tags.of(my_construct).add("key", "value", priority=300)
Java
Tags.of(myConstruct).add("key", "value", TagProps.builder()
        .priority(300).build());
C#
Tags.Of(myConstruct).Add("key", "value", new TagProps { Priority = 300 });
Go
awscdk.Tags_Of(myConstruct).Add(jsii.String("key"), jsii.String("value"), &awscdk.TagProps{
  Priority: jsii.Number(300),
})

Propiedades opcionales

Las etiquetas permiten ajustar con precisión la forma en propertiesque las etiquetas se aplican a los recursos o se eliminan de ellos. Todas las propiedades son opcionales.

applyToLaunchedInstances(Python:apply_to_launched_instances)

Disponible solo para add (). De forma predeterminada, las etiquetas se aplican a las instancias lanzadas en un grupo de Auto Scaling. Establezca esta propiedad en false para ignorar las instancias lanzadas en un grupo de Auto Scaling.

includeResourceTypes/excludeResourceTypes(Python:include_resource_types/exclude_resource_types)

Úselos para manipular las etiquetas solo en un subconjunto de recursos, en función de los tipos AWS CloudFormation de recursos. De forma predeterminada, la operación se aplica a todos los recursos del subárbol de construcción, pero esto se puede cambiar si se incluyen o excluyen determinados tipos de recursos. La exclusión tiene prioridad sobre la inclusión, si se especifican ambas opciones.

priority

Utilice esta opción para establecer la prioridad de esta operación con respecto a otras Tags.add() Tags.remove() operaciones. Los valores más altos tienen prioridad sobre los valores más bajos. El valor predeterminado es 100 para las operaciones de adición (50 para las etiquetas aplicadas directamente a AWS CloudFormation los recursos) y 200 para las operaciones de eliminación.

En el siguiente ejemplo, se aplica la etiqueta tagname con el valor y la prioridad 100 a los recursos del tipo de AWS::Xxx::Yyyla construcción. No aplica la etiqueta a las instancias lanzadas en un grupo de Auto Scaling de Amazon EC2 ni a recursos de este tipo. AWS::Xxx::Zzz (Son marcadores de posición para dos tipos de AWS CloudFormation recursos arbitrarios pero diferentes).

TypeScript
Tags.of(myConstruct).add('tagname', 'value', {
  applyToLaunchedInstances: false,
  includeResourceTypes: ['AWS::Xxx::Yyy'],
  excludeResourceTypes: ['AWS::Xxx::Zzz'],
  priority: 100,
});
JavaScript
Tags.of(myConstruct).add('tagname', 'value', {
  applyToLaunchedInstances: false,
  includeResourceTypes: ['AWS::Xxx::Yyy'],
  excludeResourceTypes: ['AWS::Xxx::Zzz'],
  priority: 100
});
Python
Tags.of(my_construct).add("tagname", "value",
    apply_to_launched_instances=False,
    include_resource_types=["AWS::Xxx::Yyy"],
    exclude_resource_types=["AWS::Xxx::Zzz"],
    priority=100)
Java
Tags.of(myConstruct).add("tagname", "value", TagProps.builder()
                .applyToLaunchedInstances(false)
                .includeResourceTypes(Arrays.asList("AWS::Xxx::Yyy"))
                .excludeResourceTypes(Arrays.asList("AWS::Xxx::Zzz"))
                .priority(100).build());
C#
Tags.Of(myConstruct).Add("tagname", "value", new TagProps
{
    ApplyToLaunchedInstances = false,
    IncludeResourceTypes = ["AWS::Xxx::Yyy"],
    ExcludeResourceTypes = ["AWS::Xxx::Zzz"],
    Priority = 100
});
Go
awscdk.Tags_Of(myConstruct).Add(jsii.String("tagname"), jsii.String("value"), &awscdk.TagProps{
  ApplyToLaunchedInstances: jsii.Bool(false),
  IncludeResourceTypes:     &[]*string{jsii.String("AWS::Xxx:Yyy")},
  ExcludeResourceTypes:     &[]*string{jsii.String("AWS::Xxx:Zzz")},
  Priority:                 jsii.Number(100),
})

En el siguiente ejemplo, se elimina la etiqueta tagname con prioridad 200 de los recursos de tipo de AWS::Xxx::Yyyla construcción, pero no de los recursos de tipo. AWS::Xxx::Zzz

TypeScript
Tags.of(myConstruct).remove('tagname', {
  includeResourceTypes: ['AWS::Xxx::Yyy'],
  excludeResourceTypes: ['AWS::Xxx::Zzz'],
  priority: 200,
});
JavaScript
Tags.of(myConstruct).remove('tagname', {
  includeResourceTypes: ['AWS::Xxx::Yyy'],
  excludeResourceTypes: ['AWS::Xxx::Zzz'],
  priority: 200
});
Python
Tags.of(my_construct).remove("tagname",
    include_resource_types=["AWS::Xxx::Yyy"],
    exclude_resource_types=["AWS::Xxx::Zzz"],
    priority=200,)
Java
Tags.of((myConstruct).remove("tagname", TagProps.builder()
        .includeResourceTypes(Arrays.asList("AWS::Xxx::Yyy"))
        .excludeResourceTypes(Arrays.asList("AWS::Xxx::Zzz"))
        .priority(100).build());
C#
Tags.Of(myConstruct).Remove("tagname", new TagProps
{
    IncludeResourceTypes = ["AWS::Xxx::Yyy"],
    ExcludeResourceTypes = ["AWS::Xxx::Zzz"],
    Priority = 100
});
Go
awscdk.Tags_Of(myConstruct).Remove(jsii.String("tagname"), &awscdk.TagProps{
  IncludeResourceTypes: &[]*string{jsii.String("AWS::Xxx:Yyy")},
  ExcludeResourceTypes: &[]*string{jsii.String("AWS::Xxx:Zzz")},
  Priority:             jsii.Number(200),
})

Ejemplo

En el siguiente ejemplo, se agrega la clave de etiqueta StackTypecon valor TheBesta cualquier recurso creado dentro del Stack nombreMarketingSystem. A continuación, lo vuelve a eliminar de todos los recursos, excepto de las subredes de VPC de Amazon EC2. El resultado es que solo las subredes tienen la etiqueta aplicada.

TypeScript
import { App, Stack, Tags } from 'aws-cdk-lib';

const app = new App();
const theBestStack = new Stack(app, 'MarketingSystem');

// Add a tag to all constructs in the stack
Tags.of(theBestStack).add('StackType', 'TheBest');

// Remove the tag from all resources except subnet resources
Tags.of(theBestStack).remove('StackType', {
  excludeResourceTypes: ['AWS::EC2::Subnet']
});
JavaScript
const { App, Stack, Tags } = require('aws-cdk-lib');

const app = new App();
const theBestStack = new Stack(app, 'MarketingSystem');

// Add a tag to all constructs in the stack
Tags.of(theBestStack).add('StackType', 'TheBest');

// Remove the tag from all resources except subnet resources
Tags.of(theBestStack).remove('StackType', {
  excludeResourceTypes: ['AWS::EC2::Subnet']
});
Python
from aws_cdk import App, Stack, Tags

app = App();
the_best_stack = Stack(app, 'MarketingSystem')

# Add a tag to all constructs in the stack
Tags.of(the_best_stack).add("StackType", "TheBest")

# Remove the tag from all resources except subnet resources
Tags.of(the_best_stack).remove("StackType",
    exclude_resource_types=["AWS::EC2::Subnet"])
Java
import software.amazon.awscdk.App;
import software.amazon.awscdk.Tags;

// Add a tag to all constructs in the stack
Tags.of(theBestStack).add("StackType", "TheBest");

// Remove the tag from all resources except subnet resources
Tags.of(theBestStack).remove("StackType", TagProps.builder()
        .excludeResourceTypes(Arrays.asList("AWS::EC2::Subnet"))
        .build());
C#
using Amazon.CDK;

var app = new App();
var theBestStack = new Stack(app, 'MarketingSystem');

// Add a tag to all constructs in the stack
Tags.Of(theBestStack).Add("StackType", "TheBest");

// Remove the tag from all resources except subnet resources
Tags.Of(theBestStack).Remove("StackType", new TagProps
{
    ExcludeResourceTypes = ["AWS::EC2::Subnet"]
});
Go
import "github.com/aws/aws-cdk-go/awscdk/v2"
app := awscdk.NewApp(nil)
theBestStack := awscdk.NewStack(app, jsii.String("MarketingSystem"), &awscdk.StackProps{})

// Add a tag to all constructs in the stack
awscdk.Tags_Of(theBestStack).Add(jsii.String("StackType"), jsii.String("TheBest"), &awscdk.TagProps{})

// Remove the tag from all resources except subnet resources
awscdk.Tags_Of(theBestStack).Add(jsii.String("StackType"), jsii.String("TheBest"), &awscdk.TagProps{
  ExcludeResourceTypes: &[]*string{jsii.String("AWS::EC2::Subnet")},
})

Con el siguiente código se obtiene el mismo resultado. Considera qué enfoque (inclusión o exclusión) aclara tu intención.

TypeScript
Tags.of(theBestStack).add('StackType', 'TheBest',
  { includeResourceTypes: ['AWS::EC2::Subnet']});
JavaScript
Tags.of(theBestStack).add('StackType', 'TheBest',
  { includeResourceTypes: ['AWS::EC2::Subnet']});
Python
Tags.of(the_best_stack).add("StackType", "TheBest",
    include_resource_types=["AWS::EC2::Subnet"])
Java
Tags.of(theBestStack).add("StackType", "TheBest", TagProps.builder()
        .includeResourceTypes(Arrays.asList("AWS::EC2::Subnet"))
        .build());
C#
Tags.Of(theBestStack).Add("StackType", "TheBest", new TagProps {
    IncludeResourceTypes = ["AWS::EC2::Subnet"]
});
Go
awscdk.Tags_Of(theBestStack).Add(jsii.String("StackType"), jsii.String("TheBest"), &awscdk.TagProps{
  IncludeResourceTypes: &[]*string{jsii.String("AWS::EC2::Subnet")},
})

Etiquetar construcciones individuales

Tags.of(scope).add(key, value)es la forma estándar de añadir etiquetas a los componentes fijos del. AWS CDK Su comportamiento de caminar por los árboles, que etiqueta de forma recursiva todos los recursos etiquetables dentro de un ámbito determinado, es casi siempre lo que se busca. Sin embargo, a veces es necesario etiquetar un constructo (o constructos) arbitrarios específicos.

Uno de estos casos implica la aplicación de etiquetas cuyo valor se deriva de alguna propiedad de la construcción que se está etiquetando. El enfoque de etiquetado estándar aplica de forma recursiva la misma clave y valor a todos los recursos coincidentes del ámbito. Sin embargo, en este caso el valor podría ser diferente para cada construcción etiquetada.

Las etiquetas se implementan mediante aspectos y la CDK llama al visit() método de la etiqueta para cada construcción dentro del ámbito especificado. Tags.of(scope) Podemos llamar Tag.visit() directamente para aplicar una etiqueta a una sola construcción.

TypeScript
new cdk.Tag(key, value).visit(scope);
JavaScript
new cdk.Tag(key, value).visit(scope);
Python
cdk.Tag(key, value).visit(scope)
Java
Tag.Builder.create(key, value).build().visit(scope);
C#
new Tag(key, value).Visit(scope);
Go
awscdk.NewTag(key, value, &awscdk.TagProps{}).Visit(scope)

Puede etiquetar todos los componentes fijos de un ámbito, pero dejar que los valores de las etiquetas se deriven de las propiedades de cada componente. Para ello, escriba un aspecto y aplique la etiqueta en el visit() método del aspecto, tal y como se muestra en el ejemplo anterior. A continuación, añada el aspecto al ámbito deseado utilizandoAspects.of(scope).add(aspect).

El siguiente ejemplo aplica una etiqueta a cada recurso de una pila que contiene la ruta del recurso.

TypeScript
class PathTagger implements cdk.IAspect {
  visit(node: IConstruct) {
    new cdk.Tag("aws-cdk-path", node.node.path).visit(node);
  }
}
 
stack = new MyStack(app);
cdk.Aspects.of(stack).add(new PathTagger())
JavaScript
class PathTagger {
  visit(node) {
    new cdk.Tag("aws-cdk-path", node.node.path).visit(node);
  }
}

stack = new MyStack(app);
cdk.Aspects.of(stack).add(new PathTagger())
Python
@jsii.implements(cdk.IAspect)
class PathTagger:
    def visit(self, node: IConstruct):
        cdk.Tag("aws-cdk-path", node.node.path).visit(node)

stack = MyStack(app) 
cdk.Aspects.of(stack).add(PathTagger())
Java
final class PathTagger implements IAspect {
	public void visit(IConstruct node) {
		Tag.Builder.create("aws-cdk-path", node.getNode().getPath()).build().visit(node);
	}
}

stack stack = new MyStack(app);
Aspects.of(stack).add(new PathTagger());
C#
public class PathTagger : IAspect
{
    public void Visit(IConstruct node)
    {
        new Tag("aws-cdk-path", node.Node.Path).Visit(node);
    }
}

var stack = new MyStack(app);
Aspects.Of(stack).Add(new PathTagger);
sugerencia

La lógica del etiquetado condicional, que incluye las prioridades, los tipos de recursos, etc., está integrada en la Tag clase. Puede utilizar estas funciones al aplicar etiquetas a recursos arbitrarios; la etiqueta no se aplica si no se cumplen las condiciones. Además, la Tag clase solo etiqueta los recursos que se pueden etiquetar, por lo que no es necesario comprobar si una construcción es etiquetable antes de aplicar una etiqueta.