Dies ist der AWS CDK v2-Entwicklerhandbuch. Das ältere CDK v1 wurde am 1. Juni 2022 in die Wartung aufgenommen und der Support wurde am 1. Juni 2023 eingestellt.
Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.
In der sind Token Platzhalter für Werte AWS Cloud Development Kit (AWS CDK), die bei der Definition von Konstrukten oder der Synthese von Stacks nicht bekannt sind. Diese Werte werden bei der Bereitstellung vollständig aufgelöst, wenn Ihre eigentliche Infrastruktur erstellt wird. Bei der Entwicklung von AWS CDK Anwendungen werden Sie mit Tokens arbeiten, um diese Werte in Ihrer gesamten Anwendung zu verwalten.
Beispiel für ein Token
Im Folgenden finden Sie ein Beispiel für einen CDK-Stack, der ein Konstrukt für einen Amazon Simple Storage Service (Amazon S3) -Bucket definiert. Da der Name unseres Buckets noch nicht bekannt ist, bucketName wird der Wert für als Token gespeichert:
import * as cdk from 'aws-cdk-lib';
import { Construct } from 'constructs';
import * as s3 from 'aws-cdk-lib/aws-s3';
export class CdkDemoAppStack extends cdk.Stack {
constructor(scope: Construct, id: string, props?: cdk.StackProps) {
super(scope, id, props);
// Define an S3 bucket
const myBucket = new s3.Bucket(this, 'myBucket');
// Store value of the S3 bucket name
const myBucketName = myBucket.bucketName;
// Print the current value for the S3 bucket name at synthesis
console.log("myBucketName: " + bucketName);
}
}Wenn wir unseren cdk synth Stack synthetisieren, myBucketName wird der Wert für im Token-Format von ${Token[TOKEN. angezeigt. Dieses Token-Format ergibt sich aus der Art und Weise, wie die Token AWS CDK codiert werden. In diesem Beispiel ist das Token als Zeichenfolge codiert:1234]}
$cdk synth --quietmyBucketName: ${Token[TOKEN.21]}
Da der Wert für unseren Bucket-Namen bei der Synthese nicht bekannt ist, wird das Token als myBucket gerendert. Unsere AWS CloudFormation Vorlage verwendet die <unique-hash>Ref systeminterne Funktion, um auf ihren Wert zu verweisen, der bei der Bereitstellung bekannt sein wird:
Resources:
myBucket5AF9C99B:
# ...
Outputs:
bucketNameOutput:
Description: The name of the S3 bucket
Value:
Ref: myBucket5AF9C99BWeitere Informationen darüber, wie der eindeutige Hash generiert wird, finden Sie unter. Logisch IDs in Ihrer AWS CloudFormation Vorlage generiert
Tokens weitergeben
Tokens können weitergegeben werden, als wären sie der tatsächliche Wert, den sie repräsentieren. Im Folgenden finden Sie ein Beispiel, das das Token für unseren Bucket-Namen an ein Konstrukt für eine AWS Lambda Funktion übergibt:
import * as cdk from 'aws-cdk-lib';
import { Construct } from 'constructs';
import * as s3 from 'aws-cdk-lib/aws-s3';
import * as lambda from 'aws-cdk-lib/aws-lambda';
export class CdkDemoAppStack extends cdk.Stack {
constructor(scope: Construct, id: string, props?: cdk.StackProps) {
super(scope, id, props);
// Define an S3 bucket
const myBucket = new s3.Bucket(this, 'myBucket');
// ...
// Define a Lambda function
const myFunction = new lambda.Function(this, "myFunction", {
runtime: lambda.Runtime.NODEJS_20_X,
handler: "index.handler",
code: lambda.Code.fromInline(`
exports.handler = async function(event) {
return {
statusCode: 200,
body: JSON.stringify('Hello World!'),
};
};
`),
functionName: myBucketName + "Function", // Pass token for the S3 bucket name
environment: {
BUCKET_NAME: myBucketName, // Pass token for the S3 bucket name
}
});
}
}Wenn wir unsere Vorlage synthetisieren, werden die Funktionen Ref und die Fn::Join systemeigenen Funktionen verwendet, um die Werte zu spezifizieren, die bei der Bereitstellung bekannt sein werden:
Resources:
myBucket5AF9C99B:
Type: AWS::S3::Bucket
# ...
myFunction884E1557:
Type: AWS::Lambda::Function
Properties:
# ...
Environment:
Variables:
BUCKET_NAME:
Ref: myBucket5AF9C99B
FunctionName:
Fn::Join:
- ""
- - Ref: myBucket5AF9C99B
- Function
# ...Wie funktionieren Token-Kodierungen
Tokens sind Objekte, die die IResolvable Schnittstelle implementieren, die eine einzige resolve Methode enthält. Während der Synthese AWS CDK ruft er diese Methode auf, um den endgültigen Wert für Token in Ihrer CloudFormation Vorlage zu erzeugen.
Anmerkung
Sie werden selten direkt mit der IResolvable Schnittstelle arbeiten. Sie werden höchstwahrscheinlich nur string-kodierte Versionen von Tokens sehen.
Typen der Token-Codierung
Token sind am Syntheseprozess beteiligt, um beliebige Werte beliebigen Typs zu erzeugen. Andere Funktionen akzeptieren normalerweise nur Argumente grundlegender Typen wie string odernumber. Um in diesen Fällen Tokens zu verwenden, können Sie sie in einen von drei Typen codieren, indem Sie statische Methoden für die cdk.Token Klasse verwenden.
-
Token.asStringum eine Zeichenkettenkodierung zu generieren (oder das Token-Objekt.toString()aufzurufen). -
Token.asListum eine Listenkodierung zu generieren. -
Token.asNumberum eine numerische Kodierung zu generieren.
Diese nehmen einen beliebigen Wert, der ein sein kannIResolvable, und kodieren ihn in einen primitiven Wert des angegebenen Typs.
Wichtig
Da es sich bei jedem der vorherigen Typen potenziell um ein codiertes Token handeln kann, sollten Sie vorsichtig sein, wenn Sie ihren Inhalt analysieren oder versuchen, ihn zu lesen. Wenn Sie beispielsweise versuchen, eine Zeichenfolge zu analysieren, um daraus einen Wert zu extrahieren, und es sich bei der Zeichenfolge um ein codiertes Token handelt, schlägt die Analyse fehl. Ebenso müssen Sie, wenn Sie versuchen, die Länge eines Arrays abzufragen oder mathematische Operationen mit einer Zahl durchzuführen, zunächst überprüfen, ob es sich nicht um kodierte Token handelt.
Wie können Sie in Ihrer App nach Tokens suchen
Um zu überprüfen, ob ein Wert ein ungelöstes Token enthält, rufen Sie die Methode Token.isUnresolved (Python:is_unresolved) auf. Das folgende Beispiel prüft, ob der Wert für unseren Amazon S3 S3-Bucket-Namen ein Token ist. Wenn es sich nicht um ein Token handelt, überprüfen wir dann die Länge des Bucket-Namens:
// ...
export class CdkDemoAppStack extends cdk.Stack {
constructor(scope: Construct, id: string, props?: cdk.StackProps) {
super(scope, id, props);
// Define an S3 bucket
const myBucket = new s3.Bucket(this, 'myBucket');
// ...
// Check if bucket name is a token. If not, check if length is less than 10 characters
if (cdk.Token.isUnresolved(myBucketName)) {
console.log("Token identified.");
} else if (!cdk.Token.isUnresolved(myBucketName) && myBucketName.length > 10) {
throw new Error('Maximum length for name is 10 characters.');
};
// ...Wenn wir ausführencdk synth, myBucketName wird es als Token identifiziert:
$cdk synth --quietToken identified.
Anmerkung
Sie können Token-Kodierungen verwenden, um dem Typsystem zu entkommen. Sie könnten beispielsweise ein Token, das bei der Synthese einen Zahlenwert erzeugt, mit einer Zeichenkette codieren. Wenn Sie diese Funktionen verwenden, liegt es in Ihrer Verantwortung, dafür zu sorgen, dass Ihre Vorlage nach der Synthese wieder in einen brauchbaren Zustand übergeht.
Arbeiten Sie mit String-codierten Tokens
Zeichenkettencodierte Token sehen wie folgt aus.
${TOKEN[Bucket.Name.1234]}
Sie können wie normale Zeichenketten weitergegeben und verkettet werden, wie im folgenden Beispiel gezeigt.
const functionName = bucket.bucketName + 'Function';Sie können auch Zeichenketteninterpolation verwenden, sofern Ihre Sprache dies unterstützt, wie im folgenden Beispiel gezeigt.
const functionName = `${bucket.bucketName}Function`;Vermeiden Sie es, die Zeichenfolge auf andere Weise zu manipulieren. Wenn Sie beispielsweise eine Teilzeichenfolge einer Zeichenfolge verwenden, wird das Zeichenketten-Token wahrscheinlich beschädigt.
Mit listencodierten Tokens arbeiten
Listenkodierte Token sehen wie folgt aus:
["#{TOKEN[Stack.NotificationArns.1234]}"]
Die einzig sichere Sache, die man mit diesen Listen machen kann, ist, sie direkt an andere Konstrukte weiterzugeben. Token in Form einer Zeichenkettenliste können nicht verkettet werden, und es kann auch kein Element aus dem Token entnommen werden. Der einzig sichere Weg, sie zu manipulieren, ist die Verwendung AWS CloudFormation systemeigener Funktionen wie fn.Select.
Arbeiten mit nummerencodierten Tokens
Zahlenkodierte Token sind eine Reihe winziger negativer Gleitkommazahlen, die wie folgt aussehen.
-1.8881545897087626e+289Wie bei Listentokens können Sie den Zahlenwert nicht ändern, da das Zahlentokens dadurch wahrscheinlich beschädigt wird.
Im Folgenden finden Sie ein Beispiel für ein Konstrukt, das ein als Zahl codiertes Token enthält:
import { Stack, Duration, StackProps } from 'aws-cdk-lib';
import { Construct } from 'constructs';
import * as rds from 'aws-cdk-lib/aws-rds';
import * as ec2 from 'aws-cdk-lib/aws-ec2';
export class CdkDemoAppStack extends Stack {
constructor(scope: Construct, id: string, props?: StackProps) {
super(scope, id, props);
// Define a new VPC
const vpc = new ec2.Vpc(this, 'MyVpc', {
maxAzs: 3, // Maximum number of availability zones to use
});
// Define an RDS database cluster
const dbCluster = new rds.DatabaseCluster(this, 'MyRDSCluster', {
engine: rds.DatabaseClusterEngine.AURORA,
instanceProps: {
vpc,
},
});
// Get the port token (this is a token encoded as a number)
const portToken = dbCluster.clusterEndpoint.port;
// Print the value for our token at synthesis
console.log("portToken: " + portToken);
}
}Wenn wir ausführencdk synth, portToken wird der Wert für als nummerncodiertes Token angezeigt:
$cdk synth --quietportToken: -1.8881545897087968e+289
Übergeben Sie nummernkodierte Token
Wenn Sie nummernkodierte Token an andere Konstrukte übergeben, kann es sinnvoll sein, sie zuerst in Zeichenketten zu konvertieren. Wenn Sie beispielsweise den Wert einer nummerierten Zeichenfolge als Teil einer verketteten Zeichenfolge verwenden möchten, hilft die Konvertierung bei der Lesbarkeit.
Im folgenden Beispiel portToken ist ein nummerencodiertes Token, das wir als Teil an unsere Lambda-Funktion übergeben möchten: connectionString
import { Stack, Duration, CfnOutput, StackProps } from 'aws-cdk-lib';
// ...
import * as lambda from 'aws-cdk-lib/aws-lambda';
export class CdkDemoAppStack extends Stack {
constructor(scope: Construct, id: string, props?: StackProps) {
super(scope, id, props);
// Define a new VPC
// ...
// Define an RDS database cluster
// ...
// Get the port token (this is a token encoded as a number)
const portToken = dbCluster.clusterEndpoint.port;
// ...
// Example connection string with the port token as a number
const connectionString = `jdbc:mysql://mydb.cluster.amazonaws.com:${portToken}/mydatabase`;
// Use the connection string as an environment variable in a Lambda function
const myFunction = new lambda.Function(this, 'MyLambdaFunction', {
runtime: lambda.Runtime.NODEJS_20_X,
handler: 'index.handler',
code: lambda.Code.fromInline(`
exports.handler = async function(event) {
return {
statusCode: 200,
body: JSON.stringify('Hello World!'),
};
};
`),
environment: {
DATABASE_CONNECTION_STRING: connectionString, // Using the port token as part of the string
},
});
// Output the value of our connection string at synthesis
console.log("connectionString: " + connectionString);
// Output the connection string
new CfnOutput(this, 'ConnectionString', {
value: connectionString,
});
}
}Wenn wir diesen Wert an übergebenconnectionString, kann der Ausgabewert bei der Ausführung aufgrund der cdk synth nummerencodierten Zeichenfolge verwirrend sein:
$cdk synth --quietconnectionString: jdbc:mysql://mydb.cluster.amazonaws.com:-1.888154589708796e+289/mydatabase
Um ein nummerenkodiertes Token in eine Zeichenfolge umzuwandeln, verwenden Sie. cdk.Tokenization.stringifyNumber( Im folgenden Beispiel konvertieren wir das nummerierte Token in eine Zeichenfolge, bevor wir unsere Verbindungszeichenfolge definieren:token)
import { Stack, Duration, Tokenization, CfnOutput, StackProps } from 'aws-cdk-lib';
// ...
export class CdkDemoAppStack extends Stack {
constructor(scope: Construct, id: string, props?: StackProps) {
super(scope, id, props);
// Define a new VPC
// ...
// Define an RDS database cluster
// ...
// Get the port token (this is a token encoded as a number)
const portToken = dbCluster.clusterEndpoint.port;
// ...
// Convert the encoded number to an encoded string for use in the connection string
const portAsString = Tokenization.stringifyNumber(portToken);
// Example connection string with the port token as a string
const connectionString = `jdbc:mysql://mydb.cluster.amazonaws.com:${portAsString}/mydatabase`;
// Use the connection string as an environment variable in a Lambda function
const myFunction = new lambda.Function(this, 'MyLambdaFunction', {
// ...
environment: {
DATABASE_CONNECTION_STRING: connectionString, // Using the port token as part of the string
},
});
// Output the value of our connection string at synthesis
console.log("connectionString: " + connectionString);
// Output the connection string
new CfnOutput(this, 'ConnectionString', {
value: connectionString,
});
}
}Wenn wir ausführencdk synth, wird der Wert für unsere Verbindungszeichenfolge in einem übersichtlicheren und klareren Format dargestellt:
$cdk synth --quietconnectionString: jdbc:mysql://mydb.cluster.amazonaws.com:${Token[TOKEN.242]}/mydatabase
Faule Werte
Neben der Darstellung von Bereitstellungszeitwerten, wie z. B. AWS CloudFormation Parametern, werden Tokens häufig auch zur Darstellung verzögerter Werte für die Synthesedauer verwendet. Dabei handelt es sich um Werte, für die der endgültige Wert bestimmt wird, bevor die Synthese abgeschlossen ist, jedoch nicht an dem Punkt, an dem der Wert konstruiert wird. Verwenden Sie Tokens, um einen literalen Zeichenketten- oder Zahlenwert an ein anderes Konstrukt zu übergeben, wobei der tatsächliche Wert zum Zeitpunkt der Synthese von einer Berechnung abhängen kann, die noch nicht durchgeführt wurde.
Sie können Tokens erstellen, die verzögerte Synth-Time-Werte darstellen, indem Sie statische Methoden für die Lazy Klasse verwenden, z. B. und. Lazy.string Lazy.number Diese Methoden akzeptieren ein Objekt, dessen produce Eigenschaft eine Funktion ist, die ein Kontextargument akzeptiert und beim Aufruf den endgültigen Wert zurückgibt.
Im folgenden Beispiel wird eine Auto Scaling Scaling-Gruppe erstellt, deren Kapazität nach ihrer Erstellung bestimmt wird.
let actualValue: number;
new AutoScalingGroup(this, 'Group', {
desiredCapacity: Lazy.numberValue({
produce(context) {
return actualValue;
}
})
});
// At some later point
actualValue = 10;Konvertierung nach JSON
Manchmal möchten Sie eine JSON-Zeichenfolge mit beliebigen Daten erstellen, und Sie wissen möglicherweise nicht, ob die Daten Token enthalten. Um jede Datenstruktur korrekt mit JSON zu codieren, unabhängig davon, ob sie Token enthält, verwenden Sie die Methodestack.toJsonString, wie im folgenden Beispiel gezeigt.
const stack = Stack.of(this);
const str = stack.toJsonString({
value: bucket.bucketName
});