cloudformation: AWS CloudFormation

Description Usage Arguments Value Service syntax Operations Examples

View source: R/cloudformation_service.R

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

1
cloudformation(config = list())

Arguments

config

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

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.

Service syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
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_stack Cancels an update on the specified stack
continue_update_rollback For a specified stack that is in the UPDATE_ROLLBACK_FAILED state, continues rolling it back to the UPDATE_ROLLBACK_COMPLETE state
create_change_set Creates a list of changes that will be applied to a stack so that you can review the changes before executing them
create_stack Creates a stack as specified in the template
create_stack_instances Creates stack instances for the specified accounts, within the specified Regions
create_stack_set Creates a stack set
delete_change_set Deletes the specified change set
delete_stack Deletes a specified stack
delete_stack_instances Deletes stack instances for the specified accounts, in the specified Regions
delete_stack_set Deletes a stack set
deregister_type Removes a type or type version from active use in the CloudFormation registry
describe_account_limits Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account
describe_change_set Returns 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_status Returns information about a stack drift detection operation
describe_stack_events Returns all stack related events for a specified stack in reverse chronological order
describe_stack_instance Returns the stack instance that's associated with the specified stack set, AWS account, and Region
describe_stack_resource Returns a description of the specified resource in the specified stack
describe_stack_resource_drifts Returns drift information for the resources that have been checked for drift in the specified stack
describe_stack_resources Returns AWS resource descriptions for running and deleted stacks
describe_stacks Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created
describe_stack_set Returns the description of the specified stack set
describe_stack_set_operation Returns the description of the specified stack set operation
describe_type Returns detailed information about a type that has been registered
describe_type_registration Returns information about a type's registration, including its current status and type and version identifiers
detect_stack_drift Detects 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_drift Returns 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_drift Detect drift on a stack set
estimate_template_cost Returns the estimated monthly cost of a template
execute_change_set Updates a stack using the input information that was provided when the specified change set was created
get_stack_policy Returns the stack policy for a specified stack
get_template Returns the template body for a specified stack
get_template_summary Returns information about a new or existing template
list_change_sets Returns the ID and status of each active change set for a stack
list_exports Lists all exported output values in the account and Region in which you call this action
list_imports Lists all stacks that are importing an exported output value
list_stack_instances Returns summary information about stack instances that are associated with the specified stack set
list_stack_resources Returns descriptions of all resources of the specified stack
list_stacks Returns the summary information for stacks whose status matches the specified StackStatusFilter
list_stack_set_operation_results Returns summary information about the results of a stack set operation
list_stack_set_operations Returns summary information about operations performed on a stack set
list_stack_sets Returns summary information about stack sets that are associated with the user
list_type_registrations Returns a list of registration tokens for the specified type(s)
list_types Returns summary information about types that have been registered with CloudFormation
list_type_versions Returns summary information about the versions of a type
record_handler_progress Reports progress of a resource handler to CloudFormation
register_type Registers a type with the CloudFormation service
set_stack_policy Sets a stack policy for a specified stack
set_type_default_version Specify the default version of a type
signal_resource Sends a signal to the specified resource with a success or failure status
stop_stack_set_operation Stops an in-progress operation on a stack set and its associated stack instances
update_stack Updates a stack as specified in the template
update_stack_instances Updates the parameter values for stack instances for the specified accounts, within the specified Regions
update_stack_set Updates the stack set, and associated stack instances in the specified accounts and Regions
update_termination_protection Updates termination protection for the specified stack
validate_template Validates a specified template

Examples

1
2
3
4
5
6
7
## Not run: 
svc <- cloudformation()
svc$cancel_update_stack(
  Foo = 123
)

## End(Not run)

paws.management documentation built on Aug. 23, 2021, 9:11 a.m.