AWS SDK for C++  1.8.60
AWS SDK for C++
Public Member Functions | Protected Member Functions | List of all members
Aws::CloudFormation::Model::DescribeStackResourcesRequest Class Reference

#include <DescribeStackResourcesRequest.h>

+ Inheritance diagram for Aws::CloudFormation::Model::DescribeStackResourcesRequest:

Public Member Functions

 DescribeStackResourcesRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetStackName () const
 
bool StackNameHasBeenSet () const
 
void SetStackName (const Aws::String &value)
 
void SetStackName (Aws::String &&value)
 
void SetStackName (const char *value)
 
DescribeStackResourcesRequestWithStackName (const Aws::String &value)
 
DescribeStackResourcesRequestWithStackName (Aws::String &&value)
 
DescribeStackResourcesRequestWithStackName (const char *value)
 
const Aws::StringGetLogicalResourceId () const
 
bool LogicalResourceIdHasBeenSet () const
 
void SetLogicalResourceId (const Aws::String &value)
 
void SetLogicalResourceId (Aws::String &&value)
 
void SetLogicalResourceId (const char *value)
 
DescribeStackResourcesRequestWithLogicalResourceId (const Aws::String &value)
 
DescribeStackResourcesRequestWithLogicalResourceId (Aws::String &&value)
 
DescribeStackResourcesRequestWithLogicalResourceId (const char *value)
 
const Aws::StringGetPhysicalResourceId () const
 
bool PhysicalResourceIdHasBeenSet () const
 
void SetPhysicalResourceId (const Aws::String &value)
 
void SetPhysicalResourceId (Aws::String &&value)
 
void SetPhysicalResourceId (const char *value)
 
DescribeStackResourcesRequestWithPhysicalResourceId (const Aws::String &value)
 
DescribeStackResourcesRequestWithPhysicalResourceId (Aws::String &&value)
 
DescribeStackResourcesRequestWithPhysicalResourceId (const char *value)
 
- Public Member Functions inherited from Aws::CloudFormation::CloudFormationRequest
virtual ~CloudFormationRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Protected Member Functions

void DumpBodyToUrl (Aws::Http::URI &uri) const override
 
- Protected Member Functions inherited from Aws::CloudFormation::CloudFormationRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 

Detailed Description

The input for DescribeStackResources action.

See Also:

AWS API Reference

Definition at line 25 of file DescribeStackResourcesRequest.h.

Constructor & Destructor Documentation

◆ DescribeStackResourcesRequest()

Aws::CloudFormation::Model::DescribeStackResourcesRequest::DescribeStackResourcesRequest ( )

Member Function Documentation

◆ DumpBodyToUrl()

void Aws::CloudFormation::Model::DescribeStackResourcesRequest::DumpBodyToUrl ( Aws::Http::URI uri) const
overrideprotectedvirtual

Default does nothing. Override this to convert what would otherwise be the payload of the request to a query string format.

Reimplemented from Aws::AmazonWebServiceRequest.

◆ GetLogicalResourceId()

const Aws::String& Aws::CloudFormation::Model::DescribeStackResourcesRequest::GetLogicalResourceId ( ) const
inline

The logical name of the resource as specified in the template.

Default: There is no default value.

Definition at line 128 of file DescribeStackResourcesRequest.h.

◆ GetPhysicalResourceId()

const Aws::String& Aws::CloudFormation::Model::DescribeStackResourcesRequest::GetPhysicalResourceId ( ) const
inline

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to find which stack the instance belongs to and what other resources are part of the stack.

Required: Conditional. If you do not specify PhysicalResourceId, you must specify StackName.

Default: There is no default value.

Definition at line 184 of file DescribeStackResourcesRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::CloudFormation::Model::DescribeStackResourcesRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file DescribeStackResourcesRequest.h.

◆ GetStackName()

const Aws::String& Aws::CloudFormation::Model::DescribeStackResourcesRequest::GetStackName ( ) const
inline

The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

Required: Conditional. If you do not specify StackName, you must specify PhysicalResourceId.

Definition at line 51 of file DescribeStackResourcesRequest.h.

◆ LogicalResourceIdHasBeenSet()

bool Aws::CloudFormation::Model::DescribeStackResourcesRequest::LogicalResourceIdHasBeenSet ( ) const
inline

The logical name of the resource as specified in the template.

Default: There is no default value.

Definition at line 134 of file DescribeStackResourcesRequest.h.

◆ PhysicalResourceIdHasBeenSet()

bool Aws::CloudFormation::Model::DescribeStackResourcesRequest::PhysicalResourceIdHasBeenSet ( ) const
inline

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to find which stack the instance belongs to and what other resources are part of the stack.

Required: Conditional. If you do not specify PhysicalResourceId, you must specify StackName.

Default: There is no default value.

Definition at line 197 of file DescribeStackResourcesRequest.h.

◆ SerializePayload()

Aws::String Aws::CloudFormation::Model::DescribeStackResourcesRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetLogicalResourceId() [1/3]

void Aws::CloudFormation::Model::DescribeStackResourcesRequest::SetLogicalResourceId ( const Aws::String value)
inline

The logical name of the resource as specified in the template.

Default: There is no default value.

Definition at line 140 of file DescribeStackResourcesRequest.h.

◆ SetLogicalResourceId() [2/3]

void Aws::CloudFormation::Model::DescribeStackResourcesRequest::SetLogicalResourceId ( Aws::String &&  value)
inline

The logical name of the resource as specified in the template.

Default: There is no default value.

Definition at line 146 of file DescribeStackResourcesRequest.h.

◆ SetLogicalResourceId() [3/3]

void Aws::CloudFormation::Model::DescribeStackResourcesRequest::SetLogicalResourceId ( const char *  value)
inline

The logical name of the resource as specified in the template.

Default: There is no default value.

Definition at line 152 of file DescribeStackResourcesRequest.h.

◆ SetPhysicalResourceId() [1/3]

void Aws::CloudFormation::Model::DescribeStackResourcesRequest::SetPhysicalResourceId ( const Aws::String value)
inline

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to find which stack the instance belongs to and what other resources are part of the stack.

Required: Conditional. If you do not specify PhysicalResourceId, you must specify StackName.

Default: There is no default value.

Definition at line 210 of file DescribeStackResourcesRequest.h.

◆ SetPhysicalResourceId() [2/3]

void Aws::CloudFormation::Model::DescribeStackResourcesRequest::SetPhysicalResourceId ( Aws::String &&  value)
inline

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to find which stack the instance belongs to and what other resources are part of the stack.

Required: Conditional. If you do not specify PhysicalResourceId, you must specify StackName.

Default: There is no default value.

Definition at line 223 of file DescribeStackResourcesRequest.h.

◆ SetPhysicalResourceId() [3/3]

void Aws::CloudFormation::Model::DescribeStackResourcesRequest::SetPhysicalResourceId ( const char *  value)
inline

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to find which stack the instance belongs to and what other resources are part of the stack.

Required: Conditional. If you do not specify PhysicalResourceId, you must specify StackName.

Default: There is no default value.

Definition at line 236 of file DescribeStackResourcesRequest.h.

◆ SetStackName() [1/3]

void Aws::CloudFormation::Model::DescribeStackResourcesRequest::SetStackName ( const Aws::String value)
inline

The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

Required: Conditional. If you do not specify StackName, you must specify PhysicalResourceId.

Definition at line 71 of file DescribeStackResourcesRequest.h.

◆ SetStackName() [2/3]

void Aws::CloudFormation::Model::DescribeStackResourcesRequest::SetStackName ( Aws::String &&  value)
inline

The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

Required: Conditional. If you do not specify StackName, you must specify PhysicalResourceId.

Definition at line 81 of file DescribeStackResourcesRequest.h.

◆ SetStackName() [3/3]

void Aws::CloudFormation::Model::DescribeStackResourcesRequest::SetStackName ( const char *  value)
inline

The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

Required: Conditional. If you do not specify StackName, you must specify PhysicalResourceId.

Definition at line 91 of file DescribeStackResourcesRequest.h.

◆ StackNameHasBeenSet()

bool Aws::CloudFormation::Model::DescribeStackResourcesRequest::StackNameHasBeenSet ( ) const
inline

The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

Required: Conditional. If you do not specify StackName, you must specify PhysicalResourceId.

Definition at line 61 of file DescribeStackResourcesRequest.h.

◆ WithLogicalResourceId() [1/3]

DescribeStackResourcesRequest& Aws::CloudFormation::Model::DescribeStackResourcesRequest::WithLogicalResourceId ( const Aws::String value)
inline

The logical name of the resource as specified in the template.

Default: There is no default value.

Definition at line 158 of file DescribeStackResourcesRequest.h.

◆ WithLogicalResourceId() [2/3]

DescribeStackResourcesRequest& Aws::CloudFormation::Model::DescribeStackResourcesRequest::WithLogicalResourceId ( Aws::String &&  value)
inline

The logical name of the resource as specified in the template.

Default: There is no default value.

Definition at line 164 of file DescribeStackResourcesRequest.h.

◆ WithLogicalResourceId() [3/3]

DescribeStackResourcesRequest& Aws::CloudFormation::Model::DescribeStackResourcesRequest::WithLogicalResourceId ( const char *  value)
inline

The logical name of the resource as specified in the template.

Default: There is no default value.

Definition at line 170 of file DescribeStackResourcesRequest.h.

◆ WithPhysicalResourceId() [1/3]

DescribeStackResourcesRequest& Aws::CloudFormation::Model::DescribeStackResourcesRequest::WithPhysicalResourceId ( const Aws::String value)
inline

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to find which stack the instance belongs to and what other resources are part of the stack.

Required: Conditional. If you do not specify PhysicalResourceId, you must specify StackName.

Default: There is no default value.

Definition at line 249 of file DescribeStackResourcesRequest.h.

◆ WithPhysicalResourceId() [2/3]

DescribeStackResourcesRequest& Aws::CloudFormation::Model::DescribeStackResourcesRequest::WithPhysicalResourceId ( Aws::String &&  value)
inline

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to find which stack the instance belongs to and what other resources are part of the stack.

Required: Conditional. If you do not specify PhysicalResourceId, you must specify StackName.

Default: There is no default value.

Definition at line 262 of file DescribeStackResourcesRequest.h.

◆ WithPhysicalResourceId() [3/3]

DescribeStackResourcesRequest& Aws::CloudFormation::Model::DescribeStackResourcesRequest::WithPhysicalResourceId ( const char *  value)
inline

The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.

For example, for an Amazon Elastic Compute Cloud (EC2) instance, PhysicalResourceId corresponds to the InstanceId. You can pass the EC2 InstanceId to DescribeStackResources to find which stack the instance belongs to and what other resources are part of the stack.

Required: Conditional. If you do not specify PhysicalResourceId, you must specify StackName.

Default: There is no default value.

Definition at line 275 of file DescribeStackResourcesRequest.h.

◆ WithStackName() [1/3]

DescribeStackResourcesRequest& Aws::CloudFormation::Model::DescribeStackResourcesRequest::WithStackName ( const Aws::String value)
inline

The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

Required: Conditional. If you do not specify StackName, you must specify PhysicalResourceId.

Definition at line 101 of file DescribeStackResourcesRequest.h.

◆ WithStackName() [2/3]

DescribeStackResourcesRequest& Aws::CloudFormation::Model::DescribeStackResourcesRequest::WithStackName ( Aws::String &&  value)
inline

The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

Required: Conditional. If you do not specify StackName, you must specify PhysicalResourceId.

Definition at line 111 of file DescribeStackResourcesRequest.h.

◆ WithStackName() [3/3]

DescribeStackResourcesRequest& Aws::CloudFormation::Model::DescribeStackResourcesRequest::WithStackName ( const char *  value)
inline

The name or the unique stack ID that is associated with the stack, which are not always interchangeable:

  • Running stacks: You can specify either the stack's name or its unique stack ID.

  • Deleted stacks: You must specify the unique stack ID.

Default: There is no default value.

Required: Conditional. If you do not specify StackName, you must specify PhysicalResourceId.

Definition at line 121 of file DescribeStackResourcesRequest.h.


The documentation for this class was generated from the following file: