/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file 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.
*/
/*
* Do not modify this file. This file is generated from the cloudformation-2010-05-15.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.CloudFormation.Model
{
///
/// Container for the parameters to the DescribeStackResources operation.
/// Returns Amazon Web Services 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.
///
///
///
/// 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 CloudFormation
/// User Guide.
///
///
///
/// A ValidationError
is returned if you specify both StackName
/// and PhysicalResourceId
in the same request.
///
///
///
public partial class DescribeStackResourcesRequest : AmazonCloudFormationRequest
{
private string _logicalResourceId;
private string _physicalResourceId;
private string _stackName;
///
/// Gets and sets the property LogicalResourceId.
///
/// The logical name of the resource as specified in the template.
///
///
///
/// Default: There is no default value.
///
///
public string LogicalResourceId
{
get { return this._logicalResourceId; }
set { this._logicalResourceId = value; }
}
// Check to see if LogicalResourceId property is set
internal bool IsSetLogicalResourceId()
{
return this._logicalResourceId != null;
}
///
/// Gets and sets the property PhysicalResourceId.
///
/// The name or unique identifier that corresponds to a physical instance ID of a resource
/// supported by 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 don't specify PhysicalResourceId
, you must
/// specify StackName
.
///
///
///
/// Default: There is no default value.
///
///
public string PhysicalResourceId
{
get { return this._physicalResourceId; }
set { this._physicalResourceId = value; }
}
// Check to see if PhysicalResourceId property is set
internal bool IsSetPhysicalResourceId()
{
return this._physicalResourceId != null;
}
///
/// Gets and sets the property StackName.
///
/// The name or the unique stack ID that is associated with the stack, which aren't 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 don't specify StackName
, you must specify
/// PhysicalResourceId
.
///
///
public string StackName
{
get { return this._stackName; }
set { this._stackName = value; }
}
// Check to see if StackName property is set
internal bool IsSetStackName()
{
return this._stackName != null;
}
}
}