cs-amazon/src/main/java/io/cloudslang/content/amazon/actions/cloudformation/CreateStackAction.java
/*
* Copyright 2019-2024 Open Text
* This program and the accompanying materials
* are made available under the terms of the Apache License v2.0 which accompany this distribution.
*
* The Apache License is available at
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License 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 2019-2024 Open Text
* This program and the accompanying materials
* are made available under the terms of the Apache License v2.0 which accompany this distribution.
*
* The Apache License is available at
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License 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.
*/
package io.cloudslang.content.amazon.actions.cloudformation;
import com.amazonaws.services.cloudformation.AmazonCloudFormation;
import com.amazonaws.services.cloudformation.model.CreateStackRequest;
import com.amazonaws.services.cloudformation.model.CreateStackResult;
import com.amazonaws.services.cloudformation.model.Parameter;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.ObjectWriter;
import com.hp.oo.sdk.content.annotations.Action;
import com.hp.oo.sdk.content.annotations.Output;
import com.hp.oo.sdk.content.annotations.Param;
import com.hp.oo.sdk.content.annotations.Response;
import com.hp.oo.sdk.content.plugin.ActionMetadata.MatchType;
import com.hp.oo.sdk.content.plugin.ActionMetadata.ResponseType;
import io.cloudslang.content.amazon.entities.constants.Constants;
import io.cloudslang.content.amazon.entities.constants.Outputs;
import io.cloudslang.content.amazon.factory.CloudFormationClientBuilder;
import io.cloudslang.content.amazon.utils.DefaultValues;
import io.cloudslang.content.amazon.utils.ParametersLine;
import io.cloudslang.content.utils.OutputUtilities;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.validator.routines.UrlValidator;
import java.util.*;
import static io.cloudslang.content.amazon.entities.constants.Inputs.CloudFormationInputs.*;
import static io.cloudslang.content.amazon.entities.constants.Inputs.CloudFormationInputs.STACK_NAME;
import static io.cloudslang.content.amazon.entities.constants.Inputs.CommonInputs.*;
import static io.cloudslang.content.amazon.entities.constants.Outputs.*;
import static org.apache.commons.lang3.StringUtils.defaultIfEmpty;
public class CreateStackAction {
/**
* Creates AWS Cloud Formation Stack in sync mode using AWS Java SDK
*
* @param identity Access key associated with your Amazon AWS or IAM account.
* Example: "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
* @param credential Secret access key ID associated with your Amazon AWS or IAM account.
* @param proxyHost Optional - proxy server used to connect to Amazon API. If empty no proxy will be used.
* Default: ""
* @param proxyPort Optional - proxy server port. You must either specify values for both proxyHost and
* proxyPort inputs or leave them both empty.
* Default: ""
* @param proxyUsername Optional - proxy server user name.
* Default: ""
* @param proxyPassword Optional - proxy server password associated with the proxyUsername input value.
* Default: ""
* @param region AWS region name
* Example: "eu-central-1"
* @param stackName Stack name to create
* Example: "MyStack"
* @param templateBody Template body in JSON or YAML format
* @param parameters Template parameters in key value format, one key=value per line
* @return A map with strings as keys and strings as values that contains: outcome of the action, returnCode of the
* operation, or failure message and the exception if there is one
*/
@Action(name = "Create AWS Cloud Formation Stack",
outputs = {
@Output(Outputs.RETURN_CODE),
@Output(Outputs.RETURN_RESULT),
@Output(Outputs.EXCEPTION)
},
responses = {
@Response(text = Outputs.SUCCESS, field = Outputs.RETURN_CODE, value = Outputs.SUCCESS_RETURN_CODE,
matchType = MatchType.COMPARE_EQUAL, responseType = ResponseType.RESOLVED),
@Response(text = Outputs.FAILURE, field = Outputs.RETURN_CODE, value = Outputs.FAILURE_RETURN_CODE,
matchType = MatchType.COMPARE_EQUAL, responseType = ResponseType.ERROR)
}
)
public Map<String, String> execute(
@Param(value = IDENTITY, required = true) String identity,
@Param(value = CREDENTIAL, required = true, encrypted = true) String credential,
@Param(value = REGION, required = true) String region,
@Param(value = PROXY_HOST) String proxyHost,
@Param(value = PROXY_PORT) String proxyPort,
@Param(value = PROXY_USERNAME) String proxyUsername,
@Param(value = PROXY_PASSWORD, encrypted = true) String proxyPassword,
@Param(value = CONNECT_TIMEOUT) String connectTimeoutMs,
@Param(value = EXECUTION_TIMEOUT) String execTimeoutMs,
@Param(value = STACK_NAME, required = true) String stackName,
@Param(value = TEMPLATE_BODY) String templateBody,
@Param(value = TEMPLATE_URL) String templateUrl,
@Param(value = PARAMETERS) String parameters,
@Param(value = CAPABILITIES) String capabilities) {
proxyPort = defaultIfEmpty(proxyPort, DefaultValues.PROXY_PORT);
connectTimeoutMs = defaultIfEmpty(connectTimeoutMs, DefaultValues.CONNECT_TIMEOUT);
execTimeoutMs = defaultIfEmpty(execTimeoutMs, DefaultValues.EXEC_TIMEOUT);
try {
final CreateStackRequest createRequest = new CreateStackRequest()
.withStackName(stackName)
.withParameters(toArrayOfParameters(parameters))
.withCapabilities(toArrayOfString(capabilities));
if (StringUtils.isNotEmpty(templateUrl)) {
UrlValidator urlValidator = new UrlValidator();
if (!urlValidator.isValid(templateUrl)) {
throw new IllegalArgumentException("templateUrl value is not a valid URL");
}
createRequest.setTemplateURL(templateUrl);
} else if (StringUtils.isNotEmpty(templateBody)) {
createRequest.setTemplateURL(templateBody);
} else {
throw new IllegalArgumentException("templateUrl or templateBody should be specified");
}
final AmazonCloudFormation stackBuilder = CloudFormationClientBuilder.getCloudFormationClient(identity, credential, proxyHost, proxyPort, proxyUsername, proxyPassword, connectTimeoutMs, execTimeoutMs, region);
final CreateStackResult createStackResult = stackBuilder.createStack(createRequest);
final String createStackResultAsString = StringUtils.defaultIfEmpty(createStackResult.toString(),"");
final ObjectWriter ow = new ObjectMapper().writer().withDefaultPrettyPrinter();
final String createStackResultAsJson = ow.writeValueAsString(createStackResult);
final HashMap<String, String> results = new HashMap();
results.put(RETURN_CODE, SUCCESS_RETURN_CODE);
results.put(RETURN_RESULT, createStackResultAsString);
results.put(RETURN_RESULT_AS_JSON, createStackResultAsJson);
return results;
} catch (Exception e) {
return OutputUtilities.getFailureResultsMap(e);
}
}
private List<Parameter> toArrayOfParameters(final String parameters) {
if ( StringUtils.isEmpty(parameters)) {
return new ArrayList<>();
}
final List<Parameter> parametersList = new ArrayList<>();
for (final String line : parameters.split(StringUtils.LF)) {
final ParametersLine paramLine = new ParametersLine(line);
if (paramLine.isValid()) {
final Parameter parameter = new Parameter();
parameter.setParameterKey(paramLine.getKey());
parameter.setParameterValue(paramLine.getValue());
parametersList.add(parameter);
}
}
return parametersList;
}
private List<String> toArrayOfString(final String capabilities) {
if (StringUtils.isEmpty(capabilities)) {
return new ArrayList<>();
}
return Arrays.asList(capabilities.split(Constants.Miscellaneous.COMMA_DELIMITER));
}
}