CloudformationDeployTask (gradle-infrastructure-plugins 1.0.2 API)

com.cloudmation.gradle.aws.cloudformation.CloudformationDeployTask

All Implemented Interfaces and Traits:

AwsConfigurable, DynamicTaskProperties
```
class CloudformationDeployTask
extends org.gradle.api.DefaultTask
```
Copyright 2020 Cloudmation LLC Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License 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.

Field Summary

Fields
Modifiers	Name	Description
`protected software.amazon.awssdk.services.cloudformation.CloudFormationClient`	`cloudformationClient`

Inherited fields
Fields inherited from class	Fields
`class org.gradle.api.DefaultTask`	`TASK_NAME, TASK_DESCRIPTION, TASK_GROUP, TASK_TYPE, TASK_DEPENDS_ON, TASK_OVERWRITE, TASK_ACTION, TASK_CONSTRUCTOR_ARGS`

Properties Summary

Properties
Type	Name and description
`java.lang.String`	`description`
`boolean`	`doNotCreate`
`boolean`	`doNotExecute`
`java.lang.String`	`group`
`java.io.File`	`templateFile`

Constructor Summary

Constructors
Constructor and description
`CloudformationDeployTask ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`boolean`	`checkStackExists(java.lang.String stackName)` Check if the named stack already exists.
	`void`	`deploy()`
	`MapConfigurationExtension`	`getAws()` Expose the AWS configuration extension as a property.
	`java.lang.String`	`getDescription()`
	`java.lang.String`	`getGeneratedStackName()`
	`java.lang.String`	`getGroup()`
	`java.lang.String`	`getTemplateName()`
	`void`	`setDescription(java.lang.String description)`
	`void`	`setDoNotCreate(boolean value)`
	`void`	`setDoNotExecute(boolean value)`
	`void`	`setGroup(java.lang.String group)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class org.gradle.api.DefaultTask`	org.gradle.api.DefaultTask#hasTaskActions(), org.gradle.api.DefaultTask#doFirst(org.gradle.api.Action), org.gradle.api.DefaultTask#doFirst(java.lang.String, org.gradle.api.Action), org.gradle.api.DefaultTask#doFirst(groovy.lang.Closure), org.gradle.api.DefaultTask#getClass(), org.gradle.api.DefaultTask#getName(), org.gradle.api.DefaultTask#getImpliesSubProjects(), org.gradle.api.DefaultTask#getOutputs(), org.gradle.api.DefaultTask#getOutputs(), org.gradle.api.DefaultTask#compareTo(org.gradle.api.Task), org.gradle.api.DefaultTask#setMustRunAfter(java.lang.Iterable), org.gradle.api.DefaultTask#compareTo(java.lang.Object), org.gradle.api.DefaultTask#getRequiredServices(), org.gradle.api.DefaultTask#getTaskDependencies(), org.gradle.api.DefaultTask#getTaskDependencies(), org.gradle.api.DefaultTask#getLocalState(), org.gradle.api.DefaultTask#prependParallelSafeAction(org.gradle.api.Action), org.gradle.api.DefaultTask#shouldRunAfter([Ljava.lang.Object;), org.gradle.api.DefaultTask#getPath(), org.gradle.api.DefaultTask#property(java.lang.String), org.gradle.api.DefaultTask#setOnlyIf(org.gradle.api.specs.Spec), org.gradle.api.DefaultTask#setOnlyIf(groovy.lang.Closure), org.gradle.api.DefaultTask#getTaskActions(), org.gradle.api.DefaultTask#getOnlyIf(), org.gradle.api.DefaultTask#getLogging(), org.gradle.api.DefaultTask#getLogging(), org.gradle.api.DefaultTask#dependsOn([Ljava.lang.Object;), org.gradle.api.DefaultTask#doLast(org.gradle.api.Action), org.gradle.api.DefaultTask#doLast(java.lang.String, org.gradle.api.Action), org.gradle.api.DefaultTask#doLast(groovy.lang.Closure), org.gradle.api.DefaultTask#setDependsOn(java.lang.Iterable), org.gradle.api.DefaultTask#getLogger(), org.gradle.api.DefaultTask#replaceLogger(org.gradle.api.logging.Logger), org.gradle.api.DefaultTask#getTaskIdentity(), org.gradle.api.DefaultTask#hasProperty(java.lang.String), org.gradle.api.DefaultTask#setEnabled(boolean), org.gradle.api.DefaultTask#setGroup(java.lang.String), org.gradle.api.DefaultTask#getConvention(), org.gradle.api.DefaultTask#isEnabled(), org.gradle.api.DefaultTask#setProperty(java.lang.String, java.lang.Object), org.gradle.api.DefaultTask#getGroup(), org.gradle.api.DefaultTask#getAnt(), org.gradle.api.DefaultTask#getProject(), org.gradle.api.DefaultTask#getDestroyables(), org.gradle.api.DefaultTask#getDependsOn(), org.gradle.api.DefaultTask#mustRunAfter([Ljava.lang.Object;), org.gradle.api.DefaultTask#wait(), org.gradle.api.DefaultTask#wait(long), org.gradle.api.DefaultTask#wait(long, int), org.gradle.api.DefaultTask#onlyIf(groovy.lang.Closure), org.gradle.api.DefaultTask#onlyIf(org.gradle.api.specs.Spec), org.gradle.api.DefaultTask#getFinalizedBy(), org.gradle.api.DefaultTask#setActions(java.util.List), org.gradle.api.DefaultTask#getIdentityPath(), org.gradle.api.DefaultTask#notifyAll(), org.gradle.api.DefaultTask#getActions(), org.gradle.api.DefaultTask#setDescription(java.lang.String), org.gradle.api.DefaultTask#getDescription(), org.gradle.api.DefaultTask#notify(), org.gradle.api.DefaultTask#getShouldRunAfter(), org.gradle.api.DefaultTask#finalizedBy([Ljava.lang.Object;), org.gradle.api.DefaultTask#setFinalizedBy(java.lang.Iterable), org.gradle.api.DefaultTask#injectIntoNewInstance(org.gradle.api.internal.project.ProjectInternal, org.gradle.api.internal.project.taskfactory.TaskIdentity, java.util.concurrent.Callable), org.gradle.api.DefaultTask#getStandardOutputCapture(), org.gradle.api.DefaultTask#appendParallelSafeAction(org.gradle.api.Action), org.gradle.api.DefaultTask#hashCode(), org.gradle.api.DefaultTask#getEnabled(), org.gradle.api.DefaultTask#getTimeout(), org.gradle.api.DefaultTask#getInputs(), org.gradle.api.DefaultTask#getInputs(), org.gradle.api.DefaultTask#getMustRunAfter(), org.gradle.api.DefaultTask#setImpliesSubProjects(boolean), org.gradle.api.DefaultTask#setShouldRunAfter(java.lang.Iterable), org.gradle.api.DefaultTask#getAsDynamicObject(), org.gradle.api.DefaultTask#getDidWork(), org.gradle.api.DefaultTask#setDidWork(boolean), org.gradle.api.DefaultTask#configure(groovy.lang.Closure), org.gradle.api.DefaultTask#configure(groovy.lang.Closure), org.gradle.api.DefaultTask#getTemporaryDirFactory(), org.gradle.api.DefaultTask#getExtensions(), org.gradle.api.DefaultTask#isHasCustomActions(), org.gradle.api.DefaultTask#usesService(org.gradle.api.provider.Provider), org.gradle.api.DefaultTask#getState(), org.gradle.api.DefaultTask#getState(), org.gradle.api.DefaultTask#equals(java.lang.Object), org.gradle.api.DefaultTask#toString(), org.gradle.api.DefaultTask#getTemporaryDir(), org.gradle.api.DefaultTask#getSharedResources()

- Field Detail
  - protected software.amazon.awssdk.services.cloudformation.CloudFormationClient cloudformationClient
- Property Detail
  - java.lang.String description
  - @org.gradle.api.tasks.Internal boolean doNotCreate
  - @org.gradle.api.tasks.Internal boolean doNotExecute
  - java.lang.String group
  - @org.gradle.api.tasks.InputFile java.io.File templateFile
- Constructor Detail
  - CloudformationDeployTask()
- Method Detail
  - boolean checkStackExists(java.lang.String stackName)
    
    Check if the named stack already exists. Special treatment is applied if a stack is in the REVIEW_IN_PROGRESS state.
    Parameters:
    stackName - Name of the stack
    Returns:
    True if the stack exists
  - @org.gradle.api.tasks.TaskAction void deploy()
  - @org.gradle.api.tasks.Internal MapConfigurationExtension getAws()
    
    Expose the AWS configuration extension as a property. Since we create the extension above in the constructor, the Gradle automagic to register the extension as a property does not happen unless we do it manually.
    Returns:
    The extension object
  - @org.gradle.api.tasks.Internal @java.lang.Override java.lang.String getDescription()
  - @org.gradle.api.tasks.Internal java.lang.String getGeneratedStackName()
  - @org.gradle.api.tasks.Internal @java.lang.Override java.lang.String getGroup()
  - @org.gradle.api.tasks.Internal java.lang.String getTemplateName()
  - @java.lang.Override void setDescription(java.lang.String description)
  - @org.gradle.api.tasks.options.Option(option = "do-not-create", description = "Does not create the stack (primarily for debugging)") void setDoNotCreate(boolean value)
  - @org.gradle.api.tasks.options.Option(option = "do-not-execute", description = "Creates the stack but does not execute the changeset (see --no-execute-changeset for AWS CLI)") void setDoNotExecute(boolean value)
  - @java.lang.Override void setGroup(java.lang.String group)

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class CloudformationDeployTask

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected software.amazon.awssdk.services.cloudformation.CloudFormationClient cloudformationClient

Property Detail

java.lang.String description

@org.gradle.api.tasks.Internal boolean doNotCreate

@org.gradle.api.tasks.Internal boolean doNotExecute

java.lang.String group

@org.gradle.api.tasks.InputFile java.io.File templateFile

Constructor Detail

CloudformationDeployTask()

Method Detail

boolean checkStackExists(java.lang.String stackName)

@org.gradle.api.tasks.TaskAction void deploy()

@org.gradle.api.tasks.Internal MapConfigurationExtension getAws()

@org.gradle.api.tasks.Internal @java.lang.Override java.lang.String getDescription()

@org.gradle.api.tasks.Internal java.lang.String getGeneratedStackName()

@org.gradle.api.tasks.Internal @java.lang.Override java.lang.String getGroup()

@org.gradle.api.tasks.Internal java.lang.String getTemplateName()

@java.lang.Override void setDescription(java.lang.String description)

@org.gradle.api.tasks.options.Option(option = "do-not-create", description = "Does not create the stack (primarily for debugging)") void setDoNotCreate(boolean value)

@org.gradle.api.tasks.options.Option(option = "do-not-execute", description = "Creates the stack but does not execute the changeset (see --no-execute-changeset for AWS CLI)") void setDoNotExecute(boolean value)

@java.lang.Override void setGroup(java.lang.String group)