AWS SDK for .NET Documentation
AmazonCloudFormationClient Class
AmazonAmazon.CloudFormationAmazonCloudFormationClient Did this page help you?   Yes   No    Tell us about it...
Implementation for accessing AmazonCloudFormation. AWS CloudFormation

AWS CloudFormation enables you to create and manage AWS infrastructure deployments predictably and repeatedly. AWS CloudFormation helps you leverage AWS products such as Amazon EC2, EBS, Amazon SNS, ELB, and Auto Scaling to build highly-reliable, highly scalable, cost effective applications without worrying about creating and 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 this product, go to the 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 http://aws.amazon.com/documentation/ .

Implementation for accessing AmazonCloudFormation. AWS CloudFormation

AWS CloudFormation enables you to create and manage AWS infrastructure deployments predictably and repeatedly. AWS CloudFormation helps you leverage AWS products such as Amazon EC2, EBS, Amazon SNS, ELB, and Auto Scaling to build highly-reliable, highly scalable, cost effective applications without worrying about creating and 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 this product, go to the 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 http://aws.amazon.com/documentation/ .

Declaration Syntax
C#
public class AmazonCloudFormationClient : AmazonWebServiceClient, 
	AmazonCloudFormation, IDisposable
Members
All MembersConstructorsMethodsEvents



IconMemberDescription
AmazonCloudFormationClient()()()()
Constructs AmazonCloudFormationClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
CopyC#
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSAccessKey" value="********************"/>
        <add key="AWSSecretKey" value="****************************************"/>
    </appSettings>
</configuration>

AmazonCloudFormationClient(RegionEndpoint)
Constructs AmazonCloudFormationClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
CopyC#
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSAccessKey" value="********************"/>
        <add key="AWSSecretKey" value="****************************************"/>
    </appSettings>
</configuration>

AmazonCloudFormationClient(AmazonCloudFormationConfig)
Constructs AmazonCloudFormationClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.
CopyC#
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <appSettings>
        <add key="AWSAccessKey" value="********************"/>
        <add key="AWSSecretKey" value="****************************************"/>
    </appSettings>
</configuration>

AmazonCloudFormationClient(AWSCredentials)
Constructs AmazonCloudFormationClient with AWS Credentials

AmazonCloudFormationClient(AWSCredentials, RegionEndpoint)
Constructs AmazonCloudFormationClient with AWS Credentials

AmazonCloudFormationClient(AWSCredentials, AmazonCloudFormationConfig)
Constructs AmazonCloudFormationClient with AWS Credentials and an AmazonCloudFormationClient Configuration object.

AmazonCloudFormationClient(String, String)
Constructs AmazonCloudFormationClient with AWS Access Key ID and AWS Secret Key

AmazonCloudFormationClient(String, String, RegionEndpoint)
Constructs AmazonCloudFormationClient with AWS Access Key ID and AWS Secret Key

AmazonCloudFormationClient(String, String, AmazonCloudFormationConfig)
Constructs AmazonCloudFormationClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudFormationClient Configuration object. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings.

AmazonCloudFormationClient(String, String, String)
Constructs AmazonCloudFormationClient with AWS Access Key ID and AWS Secret Key

AmazonCloudFormationClient(String, String, String, RegionEndpoint)
Constructs AmazonCloudFormationClient with AWS Access Key ID and AWS Secret Key

AmazonCloudFormationClient(String, String, String, AmazonCloudFormationConfig)
Constructs AmazonCloudFormationClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudFormationClient Configuration object. If the config object's UseSecureStringForAwsSecretKey is false, the AWS Secret Key is stored as a clear-text string. Please use this option only if the application environment doesn't allow the use of SecureStrings.

AfterResponseEvent
Occurs after a response is received from the service.
(Inherited from AmazonWebServiceClient.)
BeforeRequestEvent
Occurs before a request is issued against the service.
(Inherited from AmazonWebServiceClient.)
BeginCancelUpdateStack(CancelUpdateStackRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CancelUpdateStack operation.

BeginCreateStack(CreateStackRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CreateStack operation.

BeginDeleteStack(DeleteStackRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteStack operation.

BeginDescribeStackEvents(DescribeStackEventsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeStackEvents operation.

BeginDescribeStackResource(DescribeStackResourceRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeStackResource operation.

BeginDescribeStackResources(DescribeStackResourcesRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeStackResources operation.

BeginDescribeStacks(DescribeStacksRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeStacks operation.

BeginEstimateTemplateCost(EstimateTemplateCostRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the EstimateTemplateCost operation.

BeginGetStackPolicy(GetStackPolicyRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the GetStackPolicy operation.

BeginGetTemplate(GetTemplateRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the GetTemplate operation.

BeginListStackResources(ListStackResourcesRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ListStackResources operation.

BeginListStacks(ListStacksRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ListStacks operation.

BeginSetStackPolicy(SetStackPolicyRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the SetStackPolicy operation.

BeginUpdateStack(UpdateStackRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the UpdateStack operation.

BeginValidateTemplate(ValidateTemplateRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ValidateTemplate operation.

CancelUpdateStack(CancelUpdateStackRequest)

Cancels an update on the specified stack. If the call completes successfully, the stack will roll back the update and revert to the previous stack configuration.

NOTE:Only stacks that are in the UPDATE_IN_PROGRESS state can be canceled.


CreateStack(CreateStackRequest)

Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the DescribeStacks API.

NOTE: Currently, the limit for stacks is 20 stacks per account per region.


DeleteStack(DeleteStackRequest)

Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the DescribeStacks API if the deletion has been completed successfully.


DescribeStackEvents(DescribeStackEventsRequest)

Returns all stack related events for a specified stack. For more information about a stack's event history, go to Stacks in the AWS CloudFormation User Guide.

NOTE:Events are returned, even if the stack never existed or has been successfully deleted.


DescribeStackResource(DescribeStackResourceRequest)

Returns a description of the specified resource in the specified stack.

For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.


DescribeStackResources(DescribeStackResourcesRequest)

Returns AWS resource descriptions for running and deleted stacks. If StackName is specified, all the associated resources that are part of the stack are returned. If PhysicalResourceId is specified, the associated resources of the stack that the resource belongs to are returned.

NOTE:Only the first 100 resources will be returned. If your stack has more resources than this, you should use ListStackResources instead.

For deleted stacks, DescribeStackResources returns resource information for up to 90 days after the stack has been deleted.

You must specify either StackName or PhysicalResourceId , but not both. In addition, you can specify LogicalResourceId to filter the returned result. For more information about resources, the LogicalResourceId and PhysicalResourceId , go to the AWS CloudFormation User Guide .

NOTE:A ValidationError is returned if you specify both StackName and PhysicalResourceId in the same request.


DescribeStacks(DescribeStacksRequest)

Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.


DescribeStacks()()()()

Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.


Dispose()()()()
Disposes of all managed and unmanaged resources.
(Inherited from AmazonWebServiceClient.)
EndCancelUpdateStack(IAsyncResult)
Finishes the asynchronous execution of the CancelUpdateStack operation.

EndCreateStack(IAsyncResult)
Finishes the asynchronous execution of the CreateStack operation.

EndDeleteStack(IAsyncResult)
Finishes the asynchronous execution of the DeleteStack operation.

EndDescribeStackEvents(IAsyncResult)
Finishes the asynchronous execution of the DescribeStackEvents operation.

EndDescribeStackResource(IAsyncResult)
Finishes the asynchronous execution of the DescribeStackResource operation.

EndDescribeStackResources(IAsyncResult)
Finishes the asynchronous execution of the DescribeStackResources operation.

EndDescribeStacks(IAsyncResult)
Finishes the asynchronous execution of the DescribeStacks operation.

EndEstimateTemplateCost(IAsyncResult)
Finishes the asynchronous execution of the EstimateTemplateCost operation.

EndGetStackPolicy(IAsyncResult)
Finishes the asynchronous execution of the GetStackPolicy operation.

EndGetTemplate(IAsyncResult)
Finishes the asynchronous execution of the GetTemplate operation.

EndListStackResources(IAsyncResult)
Finishes the asynchronous execution of the ListStackResources operation.

EndListStacks(IAsyncResult)
Finishes the asynchronous execution of the ListStacks operation.

EndSetStackPolicy(IAsyncResult)
Finishes the asynchronous execution of the SetStackPolicy operation.

EndUpdateStack(IAsyncResult)
Finishes the asynchronous execution of the UpdateStack operation.

EndValidateTemplate(IAsyncResult)
Finishes the asynchronous execution of the ValidateTemplate operation.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
EstimateTemplateCost(EstimateTemplateCostRequest)

Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.


ExceptionEvent
Occurs after an exception is encountered.
(Inherited from AmazonWebServiceClient.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetStackPolicy(GetStackPolicyRequest)

Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.


GetTemplate(GetTemplateRequest)

Returns the template body for a specified stack. You can get the template for running or deleted stacks.

For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.

NOTE: If the template does not exist, a ValidationError is returned.


GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
ListStackResources(ListStackResourcesRequest)

Returns descriptions of all resources of the specified stack.

For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.


ListStacks(ListStacksRequest)

Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).


ListStacks()()()()

Returns the summary information for stacks whose status matches the specified StackStatusFilter. Summary information for stacks that have been deleted is kept for 90 days after the stack is deleted. If no StackStatusFilter is specified, summary information for all stacks is returned (including existing stacks and stacks that have been deleted).


SetStackPolicy(SetStackPolicyRequest)

Sets a stack policy for a specified stack.


ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
UpdateStack(UpdateStackRequest)

Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the DescribeStacks action.

Note: You cannot update AWS::S3::Bucket resources, for example, to add or modify tags.

To get a copy of the template for an existing stack, you can use the GetTemplate action.

Tags that were associated with this stack during creation time will still be associated with the stack after an UpdateStack operation.

For more information about creating an update template, updating a stack, and monitoring the progress of the update, see Updating a Stack .


ValidateTemplate(ValidateTemplateRequest)

Validates a specified template.


ValidateTemplate()()()()

Validates a specified template.


Inheritance Hierarchy
Object
AmazonWebServiceClient
 AmazonCloudFormationClient

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)