aws-sdk-synthetics 1.56.0 → 1.57.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6dff25d9cfc5d60c22b9baa9679458405ad7c3d7cbd25f1a5a32a0ce23ad6399
-  data.tar.gz: 70defe569d9c94483043e041c01a9eee94ae95eaffeec9f341d71fc98bc7178b
+  metadata.gz: 889950dbefacfd954f9d332c4982a6ffe8904526536e56e97f1dc8ffdfad9ae5
+  data.tar.gz: e340340f6411b6e04dc8f7e5822127e44fe34f82e2134c62e0331dd231ee9d54
 SHA512:
-  metadata.gz: c9084bfa5c2a96455ca7a7cb21f17aa69e1ffe39af50c5eba22214f9a927bd476ee7d42009b6cc2ae1b639526ff5e2f201af7edb18c10b09613d8f7cb329d311
-  data.tar.gz: 70714a5af5a7fc0bf7a5e261ebf68889f7d47227462a1201eaf985ee049702a70743bb0f9ff07ee52135a8fe0107a00866aa2b36c934898dd8630e4b624d1b5b
+  metadata.gz: 6a2002d0e6b97437db9d9e5b43e0a2cb960249f6351cbec982fc97ec179fcbcc89f574433085e569bde79dbd04d1654caa8fdff3a60473c4a22a56d7628bf5fb
+  data.tar.gz: 293738863741b86354d9706b4823eda630cb32ec15226e47ca678916b7a74dc3701dd467106cec8398eee13abb3e3e0e2b54930d8f28e883b75526fd118f4952

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.57.0 (2024-11-07)
+------------------
+
+* Feature - Add support to toggle if a canary will automatically delete provisioned canary resources such as Lambda functions and layers when a canary is deleted.  This behavior can be controlled via the new ProvisionedResourceCleanup property exposed in the CreateCanary and UpdateCanary APIs.
+
 1.56.0 (2024-11-06)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.56.0
+1.57.0

data/lib/aws-sdk-synthetics/client.rb

@@ -596,6 +596,20 @@ module Aws::Synthetics
     #   If you specify this parameter and don't specify any tags in the
     #   `Tags` parameter, the canary creation fails.
     #
+    # @option params [String] :provisioned_resource_cleanup
+    #   Specifies whether to also delete the Lambda functions and layers used
+    #   by this canary when the canary is deleted. If you omit this parameter,
+    #   the default of `AUTOMATIC` is used, which means that the Lambda
+    #   functions and layers will be deleted when the canary is deleted.
+    #
+    #   If the value of this parameter is `OFF`, then the value of the
+    #   `DeleteLambda` parameter of the [DeleteCanary][1] operation determines
+    #   whether the Lambda functions and layers will be deleted.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DeleteCanary.html
+    #
     # @option params [Hash<String,String>] :tags
     #   A list of key-value pairs to associate with the canary. You can
     #   associate as many as 50 tags with a canary.
@@ -650,6 +664,7 @@ module Aws::Synthetics
     #       security_group_ids: ["SecurityGroupId"],
     #     },
     #     resources_to_replicate_tags: ["lambda-function"], # accepts lambda-function
+    #     provisioned_resource_cleanup: "AUTOMATIC", # accepts AUTOMATIC, OFF
     #     tags: {
     #       "TagKey" => "TagValue",
     #     },
@@ -695,6 +710,7 @@ module Aws::Synthetics
     #   resp.canary.visual_reference.base_screenshots[0].ignore_coordinates #=> Array
     #   resp.canary.visual_reference.base_screenshots[0].ignore_coordinates[0] #=> String
     #   resp.canary.visual_reference.base_canary_run_id #=> String
+    #   resp.canary.provisioned_resource_cleanup #=> String, one of "AUTOMATIC", "OFF"
     #   resp.canary.tags #=> Hash
     #   resp.canary.tags["TagKey"] #=> String
     #   resp.canary.artifact_config.s3_encryption.encryption_mode #=> String, one of "SSE_S3", "SSE_KMS"
@@ -782,12 +798,14 @@ module Aws::Synthetics
 
     # Permanently deletes the specified canary.
     #
-    # If you specify `DeleteLambda` to `true`, CloudWatch Synthetics also
-    # deletes the Lambda functions and layers that are used by the canary.
+    # If the canary's `ProvisionedResourceCleanup` field is set to
+    # `AUTOMATIC` or you specify `DeleteLambda` in this operation as `true`,
+    # CloudWatch Synthetics also deletes the Lambda functions and layers
+    # that are used by the canary.
     #
     # Other resources used and created by the canary are not automatically
-    # deleted. After you delete a canary that you do not intend to use
-    # again, you should also delete the following:
+    # deleted. After you delete a canary, you should also delete the
+    # following:
     #
     # * The CloudWatch alarms created for this canary. These alarms have a
     #   name of
@@ -820,7 +838,12 @@ module Aws::Synthetics
     #
     # @option params [Boolean] :delete_lambda
     #   Specifies whether to also delete the Lambda functions and layers used
-    #   by this canary. The default is false.
+    #   by this canary. The default is `false`.
+    #
+    #   Your setting for this parameter is used only if the canary doesn't
+    #   have `AUTOMATIC` for its `ProvisionedResourceCleanup` field. If that
+    #   field is set to `AUTOMATIC`, then the Lambda functions and layers will
+    #   be deleted when this canary is deleted.
     #
     #   Type: Boolean
     #
@@ -968,6 +991,7 @@ module Aws::Synthetics
     #   resp.canaries[0].visual_reference.base_screenshots[0].ignore_coordinates #=> Array
     #   resp.canaries[0].visual_reference.base_screenshots[0].ignore_coordinates[0] #=> String
     #   resp.canaries[0].visual_reference.base_canary_run_id #=> String
+    #   resp.canaries[0].provisioned_resource_cleanup #=> String, one of "AUTOMATIC", "OFF"
     #   resp.canaries[0].tags #=> Hash
     #   resp.canaries[0].tags["TagKey"] #=> String
     #   resp.canaries[0].artifact_config.s3_encryption.encryption_mode #=> String, one of "SSE_S3", "SSE_KMS"
@@ -1201,6 +1225,7 @@ module Aws::Synthetics
     #   resp.canary.visual_reference.base_screenshots[0].ignore_coordinates #=> Array
     #   resp.canary.visual_reference.base_screenshots[0].ignore_coordinates[0] #=> String
     #   resp.canary.visual_reference.base_canary_run_id #=> String
+    #   resp.canary.provisioned_resource_cleanup #=> String, one of "AUTOMATIC", "OFF"
     #   resp.canary.tags #=> Hash
     #   resp.canary.tags["TagKey"] #=> String
     #   resp.canary.artifact_config.s3_encryption.encryption_mode #=> String, one of "SSE_S3", "SSE_KMS"
@@ -1732,6 +1757,18 @@ module Aws::Synthetics
     #   including the encryption-at-rest settings for artifacts that the
     #   canary uploads to Amazon S3.
     #
+    # @option params [String] :provisioned_resource_cleanup
+    #   Specifies whether to also delete the Lambda functions and layers used
+    #   by this canary when the canary is deleted.
+    #
+    #   If the value of this parameter is `OFF`, then the value of the
+    #   `DeleteLambda` parameter of the [DeleteCanary][1] operation determines
+    #   whether the Lambda functions and layers will be deleted.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DeleteCanary.html
+    #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
     # @example Request syntax with placeholder values
@@ -1781,6 +1818,7 @@ module Aws::Synthetics
     #         kms_key_arn: "KmsKeyArn",
     #       },
     #     },
+    #     provisioned_resource_cleanup: "AUTOMATIC", # accepts AUTOMATIC, OFF
     #   })
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/UpdateCanary AWS API Documentation
@@ -1810,7 +1848,7 @@ module Aws::Synthetics
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-synthetics'
-      context[:gem_version] = '1.56.0'
+      context[:gem_version] = '1.57.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-synthetics/client_api.rb

@@ -105,6 +105,7 @@ module Aws::Synthetics
     NotFoundException = Shapes::StructureShape.new(name: 'NotFoundException')
     NullableBoolean = Shapes::BooleanShape.new(name: 'NullableBoolean')
     PaginationToken = Shapes::StringShape.new(name: 'PaginationToken')
+    ProvisionedResourceCleanupSetting = Shapes::StringShape.new(name: 'ProvisionedResourceCleanupSetting')
     RequestEntityTooLargeException = Shapes::StructureShape.new(name: 'RequestEntityTooLargeException')
     ResourceArn = Shapes::StringShape.new(name: 'ResourceArn')
     ResourceList = Shapes::ListShape.new(name: 'ResourceList')
@@ -189,6 +190,7 @@ module Aws::Synthetics
     Canary.add_member(:runtime_version, Shapes::ShapeRef.new(shape: String, location_name: "RuntimeVersion"))
     Canary.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfigOutput, location_name: "VpcConfig"))
     Canary.add_member(:visual_reference, Shapes::ShapeRef.new(shape: VisualReferenceOutput, location_name: "VisualReference"))
+    Canary.add_member(:provisioned_resource_cleanup, Shapes::ShapeRef.new(shape: ProvisionedResourceCleanupSetting, location_name: "ProvisionedResourceCleanup"))
     Canary.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "Tags"))
     Canary.add_member(:artifact_config, Shapes::ShapeRef.new(shape: ArtifactConfigOutput, location_name: "ArtifactConfig"))
     Canary.struct_class = Types::Canary
@@ -270,6 +272,7 @@ module Aws::Synthetics
     CreateCanaryRequest.add_member(:runtime_version, Shapes::ShapeRef.new(shape: String, required: true, location_name: "RuntimeVersion"))
     CreateCanaryRequest.add_member(:vpc_config, Shapes::ShapeRef.new(shape: VpcConfigInput, location_name: "VpcConfig"))
     CreateCanaryRequest.add_member(:resources_to_replicate_tags, Shapes::ShapeRef.new(shape: ResourceList, location_name: "ResourcesToReplicateTags"))
+    CreateCanaryRequest.add_member(:provisioned_resource_cleanup, Shapes::ShapeRef.new(shape: ProvisionedResourceCleanupSetting, location_name: "ProvisionedResourceCleanup"))
     CreateCanaryRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "Tags"))
     CreateCanaryRequest.add_member(:artifact_config, Shapes::ShapeRef.new(shape: ArtifactConfigInput, location_name: "ArtifactConfig"))
     CreateCanaryRequest.struct_class = Types::CreateCanaryRequest
@@ -482,6 +485,7 @@ module Aws::Synthetics
     UpdateCanaryRequest.add_member(:visual_reference, Shapes::ShapeRef.new(shape: VisualReferenceInput, location_name: "VisualReference"))
     UpdateCanaryRequest.add_member(:artifact_s3_location, Shapes::ShapeRef.new(shape: String, location_name: "ArtifactS3Location"))
     UpdateCanaryRequest.add_member(:artifact_config, Shapes::ShapeRef.new(shape: ArtifactConfigInput, location_name: "ArtifactConfig"))
+    UpdateCanaryRequest.add_member(:provisioned_resource_cleanup, Shapes::ShapeRef.new(shape: ProvisionedResourceCleanupSetting, location_name: "ProvisionedResourceCleanup"))
     UpdateCanaryRequest.struct_class = Types::UpdateCanaryRequest
 
     UpdateCanaryResponse.struct_class = Types::UpdateCanaryResponse

data/lib/aws-sdk-synthetics/types.rb

@@ -209,6 +209,21 @@ module Aws::Synthetics
     #   screen to ignore during the visual monitoring comparison.
     #   @return [Types::VisualReferenceOutput]
     #
+    # @!attribute [rw] provisioned_resource_cleanup
+    #   Specifies whether to also delete the Lambda functions and layers
+    #   used by this canary when the canary is deleted. If it is
+    #   `AUTOMATIC`, the Lambda functions and layers will be deleted when
+    #   the canary is deleted.
+    #
+    #   If the value of this parameter is `OFF`, then the value of the
+    #   `DeleteLambda` parameter of the [DeleteCanary][1] operation
+    #   determines whether the Lambda functions and layers will be deleted.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DeleteCanary.html
+    #   @return [String]
+    #
     # @!attribute [rw] tags
     #   The list of key-value pairs that are associated with the canary.
     #   @return [Hash<String,String>]
@@ -237,6 +252,7 @@ module Aws::Synthetics
       :runtime_version,
       :vpc_config,
       :visual_reference,
+      :provisioned_resource_cleanup,
       :tags,
       :artifact_config)
       SENSITIVE = []
@@ -787,6 +803,22 @@ module Aws::Synthetics
     #   `Tags` parameter, the canary creation fails.
     #   @return [Array<String>]
     #
+    # @!attribute [rw] provisioned_resource_cleanup
+    #   Specifies whether to also delete the Lambda functions and layers
+    #   used by this canary when the canary is deleted. If you omit this
+    #   parameter, the default of `AUTOMATIC` is used, which means that the
+    #   Lambda functions and layers will be deleted when the canary is
+    #   deleted.
+    #
+    #   If the value of this parameter is `OFF`, then the value of the
+    #   `DeleteLambda` parameter of the [DeleteCanary][1] operation
+    #   determines whether the Lambda functions and layers will be deleted.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DeleteCanary.html
+    #   @return [String]
+    #
     # @!attribute [rw] tags
     #   A list of key-value pairs to associate with the canary. You can
     #   associate as many as 50 tags with a canary.
@@ -821,6 +853,7 @@ module Aws::Synthetics
       :runtime_version,
       :vpc_config,
       :resources_to_replicate_tags,
+      :provisioned_resource_cleanup,
       :tags,
       :artifact_config)
       SENSITIVE = []
@@ -889,7 +922,12 @@ module Aws::Synthetics
     #
     # @!attribute [rw] delete_lambda
     #   Specifies whether to also delete the Lambda functions and layers
-    #   used by this canary. The default is false.
+    #   used by this canary. The default is `false`.
+    #
+    #   Your setting for this parameter is used only if the canary doesn't
+    #   have `AUTOMATIC` for its `ProvisionedResourceCleanup` field. If that
+    #   field is set to `AUTOMATIC`, then the Lambda functions and layers
+    #   will be deleted when this canary is deleted.
     #
     #   Type: Boolean
     #   @return [Boolean]
@@ -1804,6 +1842,19 @@ module Aws::Synthetics
     #   canary uploads to Amazon S3.
     #   @return [Types::ArtifactConfigInput]
     #
+    # @!attribute [rw] provisioned_resource_cleanup
+    #   Specifies whether to also delete the Lambda functions and layers
+    #   used by this canary when the canary is deleted.
+    #
+    #   If the value of this parameter is `OFF`, then the value of the
+    #   `DeleteLambda` parameter of the [DeleteCanary][1] operation
+    #   determines whether the Lambda functions and layers will be deleted.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonSynthetics/latest/APIReference/API_DeleteCanary.html
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/synthetics-2017-10-11/UpdateCanaryRequest AWS API Documentation
     #
     class UpdateCanaryRequest < Struct.new(
@@ -1818,7 +1869,8 @@ module Aws::Synthetics
       :vpc_config,
       :visual_reference,
       :artifact_s3_location,
-      :artifact_config)
+      :artifact_config,
+      :provisioned_resource_cleanup)
       SENSITIVE = []
       include Aws::Structure
     end

data/lib/aws-sdk-synthetics.rb

@@ -54,7 +54,7 @@ module Aws::Synthetics
   autoload :EndpointProvider, 'aws-sdk-synthetics/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-synthetics/endpoints'
 
-  GEM_VERSION = '1.56.0'
+  GEM_VERSION = '1.57.0'
 
 end
 

data/sig/client.rbs

@@ -119,6 +119,7 @@ module Aws
                              security_group_ids: Array[::String]?
                            },
                            ?resources_to_replicate_tags: Array[("lambda-function")],
+                           ?provisioned_resource_cleanup: ("AUTOMATIC" | "OFF"),
                            ?tags: Hash[::String, ::String],
                            ?artifact_config: {
                              s3_encryption: {
@@ -372,7 +373,8 @@ module Aws
                                encryption_mode: ("SSE_S3" | "SSE_KMS")?,
                                kms_key_arn: ::String?
                              }?
-                           }
+                           },
+                           ?provisioned_resource_cleanup: ("AUTOMATIC" | "OFF")
                          ) -> _UpdateCanaryResponseSuccess
                        | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateCanaryResponseSuccess
     end

data/sig/types.rbs

@@ -54,6 +54,7 @@ module Aws::Synthetics
       attr_accessor runtime_version: ::String
       attr_accessor vpc_config: Types::VpcConfigOutput
       attr_accessor visual_reference: Types::VisualReferenceOutput
+      attr_accessor provisioned_resource_cleanup: ("AUTOMATIC" | "OFF")
       attr_accessor tags: ::Hash[::String, ::String]
       attr_accessor artifact_config: Types::ArtifactConfigOutput
       SENSITIVE: []
@@ -161,6 +162,7 @@ module Aws::Synthetics
       attr_accessor runtime_version: ::String
       attr_accessor vpc_config: Types::VpcConfigInput
       attr_accessor resources_to_replicate_tags: ::Array[("lambda-function")]
+      attr_accessor provisioned_resource_cleanup: ("AUTOMATIC" | "OFF")
       attr_accessor tags: ::Hash[::String, ::String]
       attr_accessor artifact_config: Types::ArtifactConfigInput
       SENSITIVE: []
@@ -440,6 +442,7 @@ module Aws::Synthetics
       attr_accessor visual_reference: Types::VisualReferenceInput
       attr_accessor artifact_s3_location: ::String
       attr_accessor artifact_config: Types::ArtifactConfigInput
+      attr_accessor provisioned_resource_cleanup: ("AUTOMATIC" | "OFF")
       SENSITIVE: []
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-synthetics
 version: !ruby/object:Gem::Version
-  version: 1.56.0
+  version: 1.57.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-06 00:00:00.000000000 Z
+date: 2024-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core