Identifikatoren und die AWS CDK

Beim Erstellen von AWS Cloud Development Kit (AWS CDK) Apps werden Sie viele Arten von Kennungen und Namen verwenden. Um sie AWS CDK effektiv zu nutzen und Fehler zu vermeiden, ist es wichtig, die Arten von Identifikatoren zu verstehen.

Identifikatoren müssen innerhalb des Bereichs, in dem sie erstellt wurden, eindeutig sein. Sie müssen in Ihrer AWS CDK Anwendung nicht global eindeutig sein.

Wenn Sie versuchen, einen Bezeichner mit demselben Wert innerhalb desselben Bereichs zu erstellen, wird eine AWS CDK Ausnahme ausgelöst.

Konstruieren IDs

Der häufigste Bezeichner,id, ist der Bezeichner, der bei der Instanziierung eines Konstruktobjekts als zweites Argument übergeben wird. Dieser Bezeichner muss, wie alle Bezeichner, nur innerhalb des Bereichs, in dem er erstellt wurde, eindeutig sein. Dies ist das erste Argument bei der Instanziierung eines Konstruktobjekts.

Schauen wir uns ein Beispiel an, bei dem wir zwei Konstrukte mit dem Identifier MyBucket in unserer App haben. Das erste ist im Bereich des Stacks mit dem Bezeichner Stack1 definiert. Der zweite ist im Gültigkeitsbereich eines Stacks mit dem Bezeichner definiertStack2. Da sie in unterschiedlichen Bereichen definiert sind, führt dies zu keinem Konflikt und sie können problemlos in derselben App koexistieren.

import { App, Stack, StackProps } from 'aws-cdk-lib';
import { Construct } from 'constructs';
import * as s3 from 'aws-cdk-lib/aws-s3';

class MyStack extends Stack {
  constructor(scope: Construct, id: string, props: StackProps = {}) {
    super(scope, id, props);

    new s3.Bucket(this, 'MyBucket');
  }
}

const app = new App();
new MyStack(app, 'Stack1');
new MyStack(app, 'Stack2');

Pfade

Die Konstrukte in einer AWS CDK Anwendung bilden eine Hierarchie, die in der Klasse verwurzelt ist. App Wir bezeichnen die Sammlung IDs von einem bestimmten Konstrukt, seinem übergeordneten Konstrukt, seinem übergeordneten Konstrukt usw. bis zur Wurzel des Konstruktbaums als Pfad.

AWS CDK In der Regel werden Pfade in Ihren Vorlagen als Zeichenfolge angezeigt. Die IDs von den Ebenen werden durch Schrägstriche getrennt, beginnend am Knoten unmittelbar unter der App Root-Instance, bei der es sich normalerweise um einen Stack handelt. Die Pfade der beiden Amazon S3 S3-Bucket-Ressourcen im vorherigen Codebeispiel lauten beispielsweise Stack1/MyBucket undStack2/MyBucket.

Sie können programmgesteuert auf den Pfad eines beliebigen Konstrukts zugreifen, wie im folgenden Beispiel gezeigt. Dies erhält den Pfad von myConstruct (odermy_construct, wie Python-Entwickler ihn schreiben würden). Da sie innerhalb des Bereichs, in dem sie erstellt wurden, eindeutig sein IDs müssen, sind ihre Pfade innerhalb einer AWS CDK Anwendung immer eindeutig.

const path: string = myConstruct.node.path;

Einzigartig IDs

AWS CloudFormation erfordert, dass alle logischen IDs Elemente in einer Vorlage eindeutig sind. Aus diesem Grund AWS CDK muss der in der Lage sein, für jedes Konstrukt in einer Anwendung einen eindeutigen Bezeichner zu generieren. Ressourcen haben Pfade, die weltweit einzigartig sind (die Namen aller Bereiche vom Stapel bis zu einer bestimmten Ressource). Daher AWS CDK generiert der die erforderlichen eindeutigen Identifikatoren, indem er die Elemente des Pfads verkettet und einen 8-stelligen Hash hinzufügt. (Der Hash ist notwendig, um verschiedene Pfade wie A/B/C und zu unterscheidenA/BC, die zu derselben Kennung führen würden. AWS CloudFormation AWS CloudFormation Bezeichner sind alphanumerisch und dürfen keine Schrägstriche oder andere Trennzeichen enthalten.) Der AWS CDK nennt diese Zeichenfolge die eindeutige ID des Konstrukts.

Im Allgemeinen sollte Ihre AWS CDK App nichts über Unique wissen müssen IDs. Sie können jedoch programmgesteuert auf die eindeutige ID eines beliebigen Konstrukts zugreifen, wie im folgenden Beispiel gezeigt.

const uid: string = Names.uniqueId(myConstruct);

Die Adresse ist eine weitere Art von eindeutiger Kennung, die CDK-Ressourcen eindeutig unterscheidet. Er wurde vom SHA-1-Hash des Pfads abgeleitet und ist nicht für Menschen lesbar. Aufgrund seiner konstanten, relativ kurzen Länge (immer 42 Hexadezimalzeichen) ist er jedoch in Situationen nützlich, in denen die „traditionelle“ eindeutige ID möglicherweise zu lang ist. Einige Konstrukte verwenden möglicherweise die Adresse in der synthetisierten AWS CloudFormation Vorlage anstelle der eindeutigen ID. Auch hier sollte Ihre App im Allgemeinen nichts über die Adressen ihrer Konstrukte wissen müssen, aber Sie können die Adresse eines Konstrukts wie folgt abrufen.

const addr: string = myConstruct.node.addr;

Logisch IDs

Unique IDs dienen als logische Bezeichner (oder logische Namen) von Ressourcen in den generierten AWS CloudFormation Vorlagen für Konstrukte, die Ressourcen darstellen AWS .

Der Amazon S3 S3-Bucket im vorherigen Beispiel, der innerhalb erstellt wurde, Stack2 führt beispielsweise zu einer AWS::S3::Bucket Ressource. Die logische ID der Ressource befindet sich Stack2MyBucket4DD88B4F in der resultierenden AWS CloudFormation Vorlage. (Einzelheiten darüber, wie dieser Bezeichner generiert wird, finden Sie unterEinzigartig IDs.)

Stabilität logischer IDs

Vermeiden Sie es, die logische ID einer Ressource zu ändern, nachdem sie erstellt wurde. AWS CloudFormation identifiziert Ressourcen anhand ihrer logischen ID. Wenn Sie also die logische ID einer Ressource ändern, AWS CloudFormation wird eine neue Ressource mit der neuen logischen ID erstellt und anschließend die vorhandene gelöscht. Je nach Ressourcentyp kann dies zu Betriebsunterbrechungen, Datenverlust oder beidem führen.