Learn R Programming

paws (version 0.1.12)

cloudformation: AWS CloudFormation

Description

AWS CloudFormation allows you to create and manage AWS infrastructure deployments predictably and repeatedly. You can use AWS CloudFormation to leverage AWS products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly-reliable, highly scalable, cost-effective applications without creating or configuring the underlying AWS infrastructure.

With AWS CloudFormation, you declare all of your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. AWS CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.

For more information about AWS CloudFormation, see the AWS CloudFormation Product Page.

Amazon CloudFormation makes use of other AWS products. If you need additional technical information about a specific AWS product, you can find the product's technical documentation at docs.aws.amazon.com.

Usage

cloudformation(config = list())

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Service syntax

svc <- cloudformation(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

cancel_update_stackCancels an update on the specified stack
continue_update_rollbackFor a specified stack that is in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state
create_change_setCreates a list of changes that will be applied to a stack so that you can review the changes before executing them
create_stackCreates a stack as specified in the template
create_stack_instancesCreates stack instances for the specified accounts, within the specified Regions
create_stack_setCreates a stack set
delete_change_setDeletes the specified change set
delete_stackDeletes a specified stack
delete_stack_instancesDeletes stack instances for the specified accounts, in the specified Regions
delete_stack_setDeletes a stack set
deregister_typeRemoves a type or type version from active use in the CloudFormation registry
describe_account_limitsRetrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account
describe_change_setReturns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the change set
describe_stack_drift_detection_statusReturns information about a stack drift detection operation
describe_stack_eventsReturns all stack related events for a specified stack in reverse chronological order
describe_stack_instanceReturns the stack instance that's associated with the specified stack set, AWS account, and Region
describe_stack_resourceReturns a description of the specified resource in the specified stack
describe_stack_resource_driftsReturns drift information for the resources that have been checked for drift in the specified stack
describe_stack_resourcesReturns AWS resource descriptions for running and deleted stacks
describe_stacksReturns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created
describe_stack_setReturns the description of the specified stack set
describe_stack_set_operationReturns the description of the specified stack set operation
describe_typeReturns detailed information about a type that has been registered
describe_type_registrationReturns information about a type's registration, including its current status and type and version identifiers
detect_stack_driftDetects whether a stack's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters
detect_stack_resource_driftReturns information about whether a resource's actual configuration differs, or has drifted, from it's expected configuration, as defined in the stack template and any values specified as template parameters
detect_stack_set_driftDetect drift on a stack set
estimate_template_costReturns the estimated monthly cost of a template
execute_change_setUpdates a stack using the input information that was provided when the specified change set was created
get_stack_policyReturns the stack policy for a specified stack
get_templateReturns the template body for a specified stack
get_template_summaryReturns information about a new or existing template
list_change_setsReturns the ID and status of each active change set for a stack
list_exportsLists all exported output values in the account and Region in which you call this action
list_importsLists all stacks that are importing an exported output value
list_stack_instancesReturns summary information about stack instances that are associated with the specified stack set
list_stack_resourcesReturns descriptions of all resources of the specified stack
list_stacksReturns the summary information for stacks whose status matches the specified StackStatusFilter
list_stack_set_operation_resultsReturns summary information about the results of a stack set operation
list_stack_set_operationsReturns summary information about operations performed on a stack set
list_stack_setsReturns summary information about stack sets that are associated with the user
list_type_registrationsReturns a list of registration tokens for the specified type(s)
list_typesReturns summary information about types that have been registered with CloudFormation
list_type_versionsReturns summary information about the versions of a type
record_handler_progressReports progress of a resource handler to CloudFormation
register_typeRegisters a type with the CloudFormation service
set_stack_policySets a stack policy for a specified stack
set_type_default_versionSpecify the default version of a type
signal_resourceSends a signal to the specified resource with a success or failure status
stop_stack_set_operationStops an in-progress operation on a stack set and its associated stack instances
update_stackUpdates a stack as specified in the template
update_stack_instancesUpdates the parameter values for stack instances for the specified accounts, within the specified Regions
update_stack_setUpdates the stack set, and associated stack instances in the specified accounts and Regions
update_termination_protectionUpdates termination protection for the specified stack
validate_templateValidates a specified template

Examples

Run this code
if (FALSE) {
svc <- cloudformation()
svc$cancel_update_stack(
  Foo = 123
)
}

Run the code above in your browser using DataLab