feat(client-synthetics): Add support to toggle outbound IPv6 traffic …

…on canaries connected to dualstack subnets. This behavior can be controlled via the new Ipv6AllowedForDualStack parameter of the VpcConfig input object in CreateCanary and UpdateCanary APIs.
aws · Dec 17, 2024 · bc1080b · bc1080b
1 parent 0e65e09
commit bc1080b
Show file tree

Hide file tree

Showing 6 changed files with 38 additions and 7 deletions.
diff --git a/clients/client-synthetics/src/commands/CreateCanaryCommand.ts b/clients/client-synthetics/src/commands/CreateCanaryCommand.ts
@@ -81,6 +81,7 @@ export interface CreateCanaryCommandOutput extends CreateCanaryResponse, __Metad
  *     SecurityGroupIds: [ // SecurityGroupIds
  *       "STRING_VALUE",
  *     ],
+ *     Ipv6AllowedForDualStack: true || false,
  *   },
  *   ResourcesToReplicateTags: [ // ResourceList
  *     "lambda-function",
@@ -140,6 +141,7 @@ export interface CreateCanaryCommandOutput extends CreateCanaryResponse, __Metad
  * //       SecurityGroupIds: [ // SecurityGroupIds
  * //         "STRING_VALUE",
  * //       ],
+ * //       Ipv6AllowedForDualStack: true || false,
  * //     },
  * //     VisualReference: { // VisualReferenceOutput
  * //       BaseScreenshots: [ // BaseScreenshots

diff --git a/clients/client-synthetics/src/commands/DescribeCanariesCommand.ts b/clients/client-synthetics/src/commands/DescribeCanariesCommand.ts
@@ -96,6 +96,7 @@ export interface DescribeCanariesCommandOutput extends DescribeCanariesResponse,
  * //         SecurityGroupIds: [ // SecurityGroupIds
  * //           "STRING_VALUE",
  * //         ],
+ * //         Ipv6AllowedForDualStack: true || false,
  * //       },
  * //       VisualReference: { // VisualReferenceOutput
  * //         BaseScreenshots: [ // BaseScreenshots

diff --git a/clients/client-synthetics/src/commands/GetCanaryCommand.ts b/clients/client-synthetics/src/commands/GetCanaryCommand.ts
@@ -84,6 +84,7 @@ export interface GetCanaryCommandOutput extends GetCanaryResponse, __MetadataBea
  * //       SecurityGroupIds: [ // SecurityGroupIds
  * //         "STRING_VALUE",
  * //       ],
+ * //       Ipv6AllowedForDualStack: true || false,
  * //     },
  * //     VisualReference: { // VisualReferenceOutput
  * //       BaseScreenshots: [ // BaseScreenshots

diff --git a/clients/client-synthetics/src/commands/UpdateCanaryCommand.ts b/clients/client-synthetics/src/commands/UpdateCanaryCommand.ts
@@ -71,6 +71,7 @@ export interface UpdateCanaryCommandOutput extends UpdateCanaryResponse, __Metad
  *     SecurityGroupIds: [ // SecurityGroupIds
  *       "STRING_VALUE",
  *     ],
+ *     Ipv6AllowedForDualStack: true || false,
  *   },
  *   VisualReference: { // VisualReferenceInput
  *     BaseScreenshots: [ // BaseScreenshots

diff --git a/clients/client-synthetics/src/models/models_0.ts b/clients/client-synthetics/src/models/models_0.ts
@@ -494,6 +494,12 @@ export interface VpcConfigOutput {
    * @public
    */
   SecurityGroupIds?: string[] | undefined;
+
+  /**
+   * <p>Indicates whether this canary allows outbound IPv6 traffic if it is connected to dual-stack subnets.</p>
+   * @public
+   */
+  Ipv6AllowedForDualStack?: boolean | undefined;
 }
 
 /**
@@ -947,6 +953,13 @@ export interface VpcConfigInput {
    * @public
    */
   SecurityGroupIds?: string[] | undefined;
+
+  /**
+   * <p>Set this to <code>true</code> to allow outbound IPv6 traffic on VPC canaries that are connected to dual-stack subnets. The default is <code>false</code>
+   *          </p>
+   * @public
+   */
+  Ipv6AllowedForDualStack?: boolean | undefined;
 }
 
 /**
@@ -1930,7 +1943,8 @@ export interface VisualReferenceInput {
    * <p>Specifies which canary run to use the screenshots from as the baseline for future visual monitoring with this canary. Valid values are
    *          <code>nextrun</code> to use the screenshots from the next run after this update is made, <code>lastrun</code> to use the screenshots from the most recent run
    *          before this update was made, or the value of <code>Id</code> in the <a href="https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CanaryRun.html">
-   *             CanaryRun</a> from any past run of this canary.</p>
+   *             CanaryRun</a> from a run of this a canary in the past 31 days. If you specify the <code>Id</code> of a canary run older than 31 days,
+   *          the operation returns a 400 validation exception error..</p>
    * @public
    */
   BaseCanaryRunId: string | undefined;

diff --git a/codegen/sdk-codegen/aws-models/synthetics.json b/codegen/sdk-codegen/aws-models/synthetics.json
@@ -314,7 +314,7 @@
           "min": 1,
           "max": 2048
         },
-        "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:synthetics:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:canary:[0-9a-z_\\-]{1,255}$"
+        "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:synthetics:[a-z]{2,4}(-[a-z]{2,4})?-[a-z]+-\\d{1}:\\d{12}:canary:[0-9a-z_\\-]{1,255}$"
       }
     },
     "com.amazonaws.synthetics#CanaryCodeInput": {
@@ -1526,7 +1526,7 @@
           "min": 1,
           "max": 2048
         },
-        "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$"
+        "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:lambda:[a-z]{2,4}(-[a-z]{2,4})?-[a-z]+-\\d{1}:\\d{12}:function:[a-zA-Z0-9-_]+(:(\\$LATEST|[a-zA-Z0-9-_]+))?$"
       }
     },
     "com.amazonaws.synthetics#GetCanary": {
@@ -1777,7 +1777,7 @@
           "min": 1,
           "max": 128
         },
-        "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:synthetics:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:group:[0-9a-z]+$"
+        "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:synthetics:[a-z]{2,4}(-[a-z]{2,4})?-[a-z]+-\\d{1}:\\d{12}:group:[0-9a-z]+$"
       }
     },
     "com.amazonaws.synthetics#GroupIdentifier": {
@@ -1863,7 +1863,7 @@
           "min": 1,
           "max": 2048
         },
-        "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:kms:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:key/[\\w\\-\\/]+$"
+        "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:kms:[a-z]{2,4}(-[a-z]{2,4})?-[a-z]+-\\d{1}:\\d{12}:key/[\\w\\-\\/]+$"
       }
     },
     "com.amazonaws.synthetics#ListAssociatedGroups": {
@@ -2291,7 +2291,7 @@
           "min": 1,
           "max": 2048
         },
-        "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:synthetics:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:\\d{12}:(canary|group):[0-9a-z_\\-]+$"
+        "smithy.api#pattern": "^arn:(aws[a-zA-Z-]*)?:synthetics:[a-z]{2,4}(-[a-z]{2,4})?-[a-z]+-\\d{1}:\\d{12}:(canary|group):[0-9a-z_\\-]+$"
       }
     },
     "com.amazonaws.synthetics#ResourceList": {
@@ -3987,7 +3987,7 @@
         "BaseCanaryRunId": {
           "target": "com.amazonaws.synthetics#String",
           "traits": {
-            "smithy.api#documentation": "<p>Specifies which canary run to use the screenshots from as the baseline for future visual monitoring with this canary. Valid values are \n         <code>nextrun</code> to use the screenshots from the next run after this update is made, <code>lastrun</code> to use the screenshots from the most recent run \n         before this update was made, or the value of <code>Id</code> in the <a href=\"https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CanaryRun.html\">\n            CanaryRun</a> from any past run of this canary.</p>",
+            "smithy.api#documentation": "<p>Specifies which canary run to use the screenshots from as the baseline for future visual monitoring with this canary. Valid values are \n         <code>nextrun</code> to use the screenshots from the next run after this update is made, <code>lastrun</code> to use the screenshots from the most recent run \n         before this update was made, or the value of <code>Id</code> in the <a href=\"https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_CanaryRun.html\">\n            CanaryRun</a> from a run of this a canary in the past 31 days. If you specify the <code>Id</code> of a canary run older than 31 days, \n         the operation returns a 400 validation exception error..</p>",
             "smithy.api#required": {}
           }
         }
@@ -4030,6 +4030,12 @@
           "traits": {
             "smithy.api#documentation": "<p>The IDs of the security groups for this canary.</p>"
           }
+        },
+        "Ipv6AllowedForDualStack": {
+          "target": "com.amazonaws.synthetics#NullableBoolean",
+          "traits": {
+            "smithy.api#documentation": "<p>Set this to <code>true</code> to allow outbound IPv6 traffic on VPC canaries that are connected to dual-stack subnets. The default is <code>false</code>\n         </p>"
+          }
         }
       },
       "traits": {
@@ -4056,6 +4062,12 @@
           "traits": {
             "smithy.api#documentation": "<p>The IDs of the security groups for this canary.</p>"
           }
+        },
+        "Ipv6AllowedForDualStack": {
+          "target": "com.amazonaws.synthetics#NullableBoolean",
+          "traits": {
+            "smithy.api#documentation": "<p>Indicates whether this canary allows outbound IPv6 traffic if it is connected to dual-stack subnets.</p>"
+          }
         }
       },
       "traits": {