4497 c++ legacy cleanup sns (awsdocs#4605)

* starting legacy cleanup

* more legacy

* all the functions done.

* testing additions

* some tests written

* Finished tests

* pretty much done

* minor change

* added some documentation

* Editorial fixes

Author: meyertst-aws

cpp/example_code/aurora/tests/gtest_getting_started_with_db_clusters.cpp

@@ -31,7 +31,7 @@ namespace AwsDocTest {
     }
 
     // NOLINTNEXTLINE(readability-named-parameter)
-    TEST_F(Aurora_GTests, gettingStartedWithDBInstances_3_) {
+    TEST_F(Aurora_GTests, gettingStartedWithDBClusters_3_) {
         AddCommandLineResponses(RESPONSES);
 
         MockHTTP mockHttp;
@@ -135,7 +135,7 @@ namespace AwsDocTest {
         if (!mockHttp.addResponseWithBody("mock_input/626-DeleteDBInstance.xml")) {
             return false;
         }
-        if (!mockHttp.addResponseWithBody("mock_input/627-DeleteDBCLuster.xml")) {
+        if (!mockHttp.addResponseWithBody("mock_input/627-DeleteDBCluster.xml")) {
             return false;
         }
         if (!mockHttp.addResponseWithBody("mock_input/628-DescribeDBInstances.xml")) {

cpp/example_code/sns/CMakeLists.txt

@@ -1,155 +1,64 @@
-# Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
-# This file is licensed under the Apache License, Version 2.0 (the "License").
-# You may not use this file except in compliance with the License. A copy of
-# the License is located at
-# http://aws.amazon.com/apache2.0/
-# This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
-# CONDITIONS OF ANY KIND, either express or implied. See the License for the
-# specific language governing permissions and limitations under the License.
+# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
 
 # Set the minimum required version of CMake for this project.
 cmake_minimum_required(VERSION 3.8)
 
+set(SERVICE_NAME sns)
+set(SERVICE_COMPONENTS sns)
+
 # Set this project's name.
-project("sns-examples")
+project("${SERVICE_NAME}-examples")
 
 # Set the C++ standard to use to build this target.
 set(CMAKE_CXX_STANDARD 11)
 
-# Enable CTest for testing these code examples.
-include(CTest)
-
 # Build shared libraries by default.
-if(NOT BUILD_SHARED_LIBS)
-    set(BUILD_SHARED_LIBS ON)
-endif()
+set(BUILD_SHARED_LIBS ON)
 
-list(APPEND CMAKE_PREFIX_PATH "C:\\Program Files (x86)\\aws-cpp-sdk-all\\lib\\cmake")
-#Set the location of where Windows can find the installed libraries of the SDK.
-if(MSVC)
+# Set the location of where Windows can find the installed libraries of the SDK.
+if (MSVC)
     string(REPLACE ";" "/aws-cpp-sdk-all;" SYSTEM_MODULE_PATH "${CMAKE_SYSTEM_PREFIX_PATH}/aws-cpp-sdk-all")
     list(APPEND CMAKE_PREFIX_PATH ${SYSTEM_MODULE_PATH})
-endif()
+endif ()
 
-# Locate the aws sdk for c++ package.
-find_package(AWSSDK REQUIRED COMPONENTS sns)
+# Find the AWS SDK for C++ package.
+find_package(AWSSDK REQUIRED COMPONENTS ${SERVICE_COMPONENTS})
 
-# If the compiler is some version of Microsoft Visual C++,
+# If the compiler is some version of Microsoft Visual C++, or another compiler simulating C++,
 # and building as shared libraries, then dynamically link to those shared libraries.
-if(MSVC AND BUILD_SHARED_LIBS)
-    add_definitions(-DUSE_IMPORT_EXPORT)
+if (MSVC)
+    set(CMAKE_BUILD_TYPE Debug) # Explicitly setting CMAKE_BUILD_TYPE is necessary in Windows to copy DLLs.
+
+    list(APPEND SERVICE_LIST ${SERVICE_COMPONENTS})
+
     # Copy relevant AWS SDK for C++ libraries into the current binary directory for running and debugging.
-    list(APPEND SERVICE_LIST sns)
-    
-    #For IDE's like Xcode and Visual Studio this line will be ignored because Release/Debug 
-    #  is switched internally, but this is necessary for non-IDE builds.
-    set(CMAKE_BUILD_TYPE Debug) #TODO: Set to your build type
-	
-    #TODO:Choose appropriate one of the following two lines, you want to copy to the same folder where your executables are.
-    AWSSDK_CPY_DYN_LIBS(SERVICE_LIST "" ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_BUILD_TYPE})  #Choose this line if your executables are in /build/Debug
-    #AWSSDK_CPY_DYN_LIBS(SERVICE_LIST "" ${CMAKE_CURRENT_BINARY_DIR})  #Choose this line for Visual Studio and possibly other IDEs
-    
-    message(STATUS ">>CMAKE_CURRENT_BINARY_DIR: ${CMAKE_CURRENT_BINARY_DIR}")
-    message(STATUS ">>CMAKE_BUILD_TYPE: ${CMAKE_BUILD_TYPE}")
-    message(STATUS ">>EXECUTABLE_OUTPUT_PATH : ${EXECUTABLE_OUTPUT_PATH}")
-endif()
-
-
-#set(EXAMPLES "")
-#list(APPEND EXAMPLES "create_topic")
-#list(APPEND EXAMPLES "delete_topic")
-#list(APPEND EXAMPLES "get_sms_type")
-#list(APPEND EXAMPLES "get_topic_attributes")
-#list(APPEND EXAMPLES "list_subscriptions")
-#list(APPEND EXAMPLES "list_topics")
-#list(APPEND EXAMPLES "publish_sms")
-#list(APPEND EXAMPLES "publish_to_topic")
-#list(APPEND EXAMPLES "set_sms_type")
-#list(APPEND EXAMPLES "subscribe_app")
-#list(APPEND EXAMPLES "subscribe_email")
-#list(APPEND EXAMPLES "subscribe_lambda")
-#list(APPEND EXAMPLES "unsubscribe")
-
-# Add the code example-specific header files. (none-currently, placeholder)
-file(GLOB AWSDOC_HEADERS
-    "include/awsdoc/ex/*.h"
-)
-
-# Add the code example-specific source files.
-file(GLOB AWSDOC_SOURCE
-    "*.cpp"
-)
-
-# Check whether the target system is Windows, including Win64.
-if(WIN32)
-    # Check whether the compiler is some version of Microsoft Visual C++, or another compiler simulating C++.
-    if(MSVC)
-        source_group("Header Files\\awsdoc\\ex" FILES ${AWSDOC_HEADERS})
-        source_group("Source Files" FILES ${AWSDOC_SOURCE})
-    endif(MSVC)
-endif()
-
-foreach(file ${AWSDOC_SOURCE})
+    AWSSDK_CPY_DYN_LIBS(SERVICE_LIST "" ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_BUILD_TYPE})
+endif ()
+
+# AWSDOC_SOURCE can be defined in the command line to limit the files in a build. For example,
+# you can limit files to one action.
+if (NOT DEFINED AWSDOC_SOURCE)
+    file(GLOB AWSDOC_SOURCE
+            "*.cpp"
+            )
+endif ()
+
+foreach (file ${AWSDOC_SOURCE})
     get_filename_component(EXAMPLE ${file} NAME_WE)
 
     # Build the code example executables.
     set(EXAMPLE_EXE run_${EXAMPLE})
 
-    add_executable(${EXAMPLE_EXE} ${AWSDOC_HEADERS} ${file})
+    add_executable(${EXAMPLE_EXE} ${file})
 
-    if(MSVC AND BUILD_SHARED_LIBS)
-        target_compile_definitions(${EXAMPLE_EXE} PUBLIC "USE_IMPORT_EXPORT")
-        target_compile_definitions(${EXAMPLE_EXE} PRIVATE "AWSDOC_EXPORTS")
-    endif()
-
-    target_include_directories(${EXAMPLE_EXE} PUBLIC
-        $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
-        $<INSTALL_INTERFACE:include>)
     target_link_libraries(${EXAMPLE_EXE} ${AWSSDK_LINK_LIBRARIES}
-        ${AWSSDK_PLATFORM_DEPS})
-
-    if(BUILD_TESTING)
-        # Enable testing for this directory and below.
-        enable_testing()
-
-        # Build the code example libraries.
-        set(EXAMPLE_LIB ${EXAMPLE})
-
-        add_library(${EXAMPLE_LIB} ${AWSDOC_HEADERS} ${file} )
-
-        if(MSVC AND BUILD_SHARED_LIBS)
-            target_compile_definitions(${EXAMPLE_LIB} PUBLIC "USE_IMPORT_EXPORT")
-            target_compile_definitions(${EXAMPLE_LIB} PRIVATE "AWSDOC_EXPORTS")
-        endif()
-
-        target_include_directories(${EXAMPLE_LIB} PUBLIC
-            $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
-            $<INSTALL_INTERFACE:include>)
-        target_link_libraries(${EXAMPLE_LIB} ${AWSSDK_LINK_LIBRARIES}
             ${AWSSDK_PLATFORM_DEPS})
 
-        # Build the code example unit tests.
-        set(EXAMPLE_TEST test_${EXAMPLE})
-        set(EXAMPLE_TEST_FILE ${CMAKE_CURRENT_SOURCE_DIR}/tests/test_${EXAMPLE}.cpp)
-
-        if(EXISTS ${EXAMPLE_TEST_FILE})
-            add_executable(${EXAMPLE_TEST} ${EXAMPLE_TEST_FILE} )
-
-            target_include_directories(${EXAMPLE_TEST} PUBLIC
-                $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
-                $<INSTALL_INTERFACE:include>)
-            target_link_libraries(${EXAMPLE_TEST} ${EXAMPLE_LIB} )
-            add_test(${EXAMPLE_TEST} ${EXAMPLE_TEST})
-        endif()
-
-    endif()
-endforeach()
-
+endforeach ()
 
 
+if (BUILD_TESTS)
+    add_subdirectory(tests)
+endif ()
 
-# The executables to build.
-foreach(EXAMPLE IN LISTS EXAMPLES)
-  add_executable(${EXAMPLE} ${EXAMPLE}.cpp)
-	target_link_libraries(${EXAMPLE} ${AWSSDK_LINK_LIBRARIES})
-endforeach()

cpp/example_code/sns/README.md

@@ -1,45 +1,97 @@
-# Amazon SNS C++ SDK code examples
+<!--Generated by WRITEME on 2023-03-29 13:24:55.530150 (UTC)-->
+# Amazon SNS code examples for the SDK for C++
 
-## Purpose
-The code examples in this directory demonstrate how to work with the Amazon Simple Notification Service 
-(Amazon SNS) using the AWS SDK for C++.
+## Overview
 
-Amazon SNS is a fully managed messaging service for both application-to-application (A2A) and application-to-person (A2P) communication. 
+Shows how to use the AWS SDK for C++ to work with Amazon Simple Notification Service (Amazon SNS).
 
-## Code examples
-This is a workspace where you can find AWS SDK for C++ SNS examples.
-
-- [Creating an Amazon SNS topic to which notifications can be published](./create_topic.cpp) (CreateTopic)
-- [Deleting an Amazon SNS topic and all its subscriptions](./delete_topic.cpp) (DeleteTopic)
-- [Retrieving the settings for sending Amazon SMS messages](./get_sms_type.cpp) (GetSMSAttributes)
-- [Retrieving the properties of an Amazon SNS topic](./get_topic_attributes.cpp) (GetTopicAttributes)
-- [Retrieving a list of Amazon SNS subscriptions](./list_subscriptions.cpp) (ListSubscriptions)
-- [Retrieving a list of Amazon SNS topics](./list_topics.cpp) (ListTopics)
-- [Sending an SMS text message to a phone number](./publish_sms.cpp) (Publish)
-- [Sending a message to an Amazon SNS topic](./publish_to_topic.cpp) (Publish)
-- [Setting default SMS attributes](./set_sms_type.cpp) (SetSMSAttributes)
-- [Subscribing to an Amazon SNS topic with delivery to a mobile app](./subscribe_app.cpp) (Subscribe)
-- [Subscribing to an Amazon SNS topic with delivery to an email address](./subscribe_email.cpp) (Subscribe)
-- [Subscribing to an Amazon SNS topic with delivery to an AWS Lambda function](./subscribe_lambda.cpp) (Subscribe)
-- [Unsubscribing to an Amazon SNS topic](./unsubscribe.cpp) (Unsubscribe)
+<!--custom.overview.start-->
+<!--custom.overview.end-->
+
+*Amazon SNS is a web service that enables applications, end-users, and devices to instantly send and receive notifications from the cloud.*
 
 ## ⚠ Important
-- We recommend that you grant your code least privilege, or at most the minimum permissions required to perform the task. For more information, see [Grant Least Privilege](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege) in the AWS Identity and Access Management User Guide.
-- This code has not been tested in all AWS Regions. Some AWS services are available only in specific [Regions](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).
-- Running this code might result in charges to your AWS account. 
-- Running the unit tests might result in charges to your AWS account. [optional]
 
-## Running the Examples
-Before using the code examples, first complete the installation and setup steps of [Getting Started](https://docs.aws.amazon.com/sdk-for-cpp/v1/developer-guide/getting-started.html) in the AWS SDK for C++ Developer Guide.
-The Getting Started section covers how to obtain and build the SDK, and how to build your own code utilizing the SDK with a sample "Hello World"-style application. 
+* Running this code might result in charges to your AWS account.
+* Running the tests might result in charges to your AWS account.
+* We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see [Grant least privilege](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#grant-least-privilege).
+* This code is not tested in every AWS Region. For more information, see [AWS Regional Services](https://aws.amazon.com/about-aws/global-infrastructure/regional-product-services).
+
+<!--custom.important.start-->
+<!--custom.important.end-->
+
+## Code examples
+### Single actions
+
+Code excerpts that show you how to call individual service functions.
+
+* [Create a topic](create_topic.cpp#L23) (`CreateTopic`)
+* [Delete a subscription](unsubscribe.cpp#L23) (`Unsubscribe`)
+* [Delete a topic](delete_topic.cpp#L23) (`DeleteTopic`)
+* [Get the properties of a topic](get_topic_attributes.cpp#L25) (`GetTopicAttributes`)
+* [Get the settings for sending SMS messages](get_sms_type.cpp#L23) (`GetSMSAttributes`)
+* [List the subscribers of a topic](list_subscriptions.cpp#L23) (`ListSubscriptions`)
+* [List topics](list_topics.cpp#L23) (`ListTopics`)
+* [Publish an SMS text message](publish_sms.cpp#L23) (`Publish`)
+* [Publish to a topic](publish_to_topic.cpp#L23) (`Publish`)
+* [Set the default settings for sending SMS messages](set_sms_type.cpp#L24) (`SetSmsAttributes`)
+* [Subscribe a Lambda function to a topic](subscribe_lambda.cpp#L23) (`Subscribe`)
+* [Subscribe a mobile application to a topic](subscribe_app.cpp#L23) (`Subscribe`)
+* [Subscribe an email address to a topic](subscribe_email.cpp#L18) (`Subscribe`)
+
+## Run the examples
+
+### Prerequisites
+
+
+
+Before using the code examples, first complete the installation and setup steps
+for [Getting started](https://docs.aws.amazon.com/sdk-for-cpp/v1/developer-guide/getting-started.html) in the AWS SDK for
+C++ Developer Guide.
+This section covers how to get and build the SDK, and how to build your own code by using the SDK with a
+sample Hello World-style application.
+
+Next, for information on code example structures and how to build and run the examples, see [Getting started with the AWS SDK for C++ code examples](https://docs.aws.amazon.com/sdk-for-cpp/v1/developer-guide/getting-started-code-examples.html).
+
+
+<!--custom.prerequisites.start-->
+<!--custom.prerequisites.end-->
+
+### Instructions
+
+
+<!--custom.instructions.start-->
+<!--custom.instructions.end-->
+
+
+### Tests
+
+⚠ Running tests might result in charges to your AWS account.
+
+
+
+```sh
+   cd <BUILD_DIR>
+   cmake <path-to-root-of-this-source-code> -DBUILD_TESTS=ON
+   make
+   ctest
+```
+
+
+<!--custom.tests.start-->
+<!--custom.tests.end-->
+
+## Additional resources
+
+* [Amazon SNS Developer Guide](https://docs.aws.amazon.com/sns/latest/dg/welcome.html)
+* [Amazon SNS API Reference](https://docs.aws.amazon.com/sns/latest/api/welcome.html)
+* [SDK for C++ Amazon SNS reference](https://sdk.amazonaws.com/cpp/api/LATEST/aws-cpp-sdk-sns/html/annotated.html)
 
-Next, see [Getting started with the AWS SDK for C++ code examples](https://docs.aws.amazon.com/sdk-for-cpp/v1/developer-guide/getting-started-code-examples.html) for information on the structure of the code examples, building, and running the examples.
+<!--custom.resources.start-->
+<!--custom.resources.end-->
 
-To run these code examples, your AWS user must have permissions to perform these actions with SNS.  
-The AWS managed policy named "AmazonSNSFullAccess" may be used to bulk-grant the necessary permissions.  
-For more information on attaching policies to IAM user groups, 
-see [Attaching a policy to an IAM user group](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups_manage_attach-policy.html).
+---
 
-## Resources
-- [AWS SDK for C++ Documentation](https://docs.aws.amazon.com/sdk-for-cpp/index.html) 
+Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 
+SPDX-License-Identifier: Apache-2.0