Updated documentation about the fix

aws · Jul 8, 2021 · 168bb9b · 168bb9b
1 parent fd5cbb3
commit 168bb9b
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/packages/@aws-cdk/aws-ecs/README.md b/packages/@aws-cdk/aws-ecs/README.md
@@ -617,6 +617,22 @@ taskDefinition.addContainer('TheContainer', {
 });
 ```
 
+When providing the Splunk token in the `token` field it gets resolved to the secret value on deploying. Hence it is encouraged to use the `secretToken` field for specifying the Splunk token as a `Secret` which will be populated in the Log Driver `SecretOptions`. Below is an example task definition with both fields specified:
+
+```ts
+// Create a Task Definition for the container to start
+const taskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef');
+taskDefinition.addContainer('TheContainer', {
+  image: ecs.ContainerImage.fromRegistry('example-image'),
+  memoryLimitMiB: 256,
+  logging: ecs.LogDrivers.splunk({
+    token: cdk.SecretValue.secretsManager('my-splunk-token'),
+    secretToken: ecs.Secret.fromSecretsManager(secret),
+    url: 'my-splunk-url'
+  })
+});
+```
+
 ### syslog Log Driver
 
 ```ts

diff --git a/packages/@aws-cdk/aws-ecs/lib/log-drivers/splunk-log-driver.ts b/packages/@aws-cdk/aws-ecs/lib/log-drivers/splunk-log-driver.ts
@@ -25,7 +25,7 @@ export enum SplunkLogFormat {
 export interface SplunkLogDriverProps extends BaseLogDriverProps {
   /**
    * Splunk HTTP Event Collector token.
-   * @deprecated Use `secretToken` instead.
+   * @deprecated Use {@link SplunkLogDriverProps.secretToken} instead.
    */
   readonly token: SecretValue;