1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
/// <p>The input for <code>DescribeStackResources</code> action.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct DescribeStackResourcesInput {
/// <p>The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:</p>
/// <ul>
/// <li>
/// <p>Running stacks: You can specify either the stack's name or its unique stack ID.</p></li>
/// <li>
/// <p>Deleted stacks: You must specify the unique stack ID.</p></li>
/// </ul>
/// <p>Default: There is no default value.</p>
/// <p>Required: Conditional. If you don't specify <code>StackName</code>, you must specify <code>PhysicalResourceId</code>.</p>
pub stack_name: ::std::option::Option<::std::string::String>,
/// <p>The logical name of the resource as specified in the template.</p>
/// <p>Default: There is no default value.</p>
pub logical_resource_id: ::std::option::Option<::std::string::String>,
/// <p>The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.</p>
/// <p>For example, for an Amazon Elastic Compute Cloud (EC2) instance, <code>PhysicalResourceId</code> corresponds to the <code>InstanceId</code>. You can pass the EC2 <code>InstanceId</code> to <code>DescribeStackResources</code> to find which stack the instance belongs to and what other resources are part of the stack.</p>
/// <p>Required: Conditional. If you don't specify <code>PhysicalResourceId</code>, you must specify <code>StackName</code>.</p>
/// <p>Default: There is no default value.</p>
pub physical_resource_id: ::std::option::Option<::std::string::String>,
}
impl DescribeStackResourcesInput {
/// <p>The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:</p>
/// <ul>
/// <li>
/// <p>Running stacks: You can specify either the stack's name or its unique stack ID.</p></li>
/// <li>
/// <p>Deleted stacks: You must specify the unique stack ID.</p></li>
/// </ul>
/// <p>Default: There is no default value.</p>
/// <p>Required: Conditional. If you don't specify <code>StackName</code>, you must specify <code>PhysicalResourceId</code>.</p>
pub fn stack_name(&self) -> ::std::option::Option<&str> {
self.stack_name.as_deref()
}
/// <p>The logical name of the resource as specified in the template.</p>
/// <p>Default: There is no default value.</p>
pub fn logical_resource_id(&self) -> ::std::option::Option<&str> {
self.logical_resource_id.as_deref()
}
/// <p>The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.</p>
/// <p>For example, for an Amazon Elastic Compute Cloud (EC2) instance, <code>PhysicalResourceId</code> corresponds to the <code>InstanceId</code>. You can pass the EC2 <code>InstanceId</code> to <code>DescribeStackResources</code> to find which stack the instance belongs to and what other resources are part of the stack.</p>
/// <p>Required: Conditional. If you don't specify <code>PhysicalResourceId</code>, you must specify <code>StackName</code>.</p>
/// <p>Default: There is no default value.</p>
pub fn physical_resource_id(&self) -> ::std::option::Option<&str> {
self.physical_resource_id.as_deref()
}
}
impl DescribeStackResourcesInput {
/// Creates a new builder-style object to manufacture [`DescribeStackResourcesInput`](crate::operation::describe_stack_resources::DescribeStackResourcesInput).
pub fn builder() -> crate::operation::describe_stack_resources::builders::DescribeStackResourcesInputBuilder {
crate::operation::describe_stack_resources::builders::DescribeStackResourcesInputBuilder::default()
}
}
/// A builder for [`DescribeStackResourcesInput`](crate::operation::describe_stack_resources::DescribeStackResourcesInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct DescribeStackResourcesInputBuilder {
pub(crate) stack_name: ::std::option::Option<::std::string::String>,
pub(crate) logical_resource_id: ::std::option::Option<::std::string::String>,
pub(crate) physical_resource_id: ::std::option::Option<::std::string::String>,
}
impl DescribeStackResourcesInputBuilder {
/// <p>The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:</p>
/// <ul>
/// <li>
/// <p>Running stacks: You can specify either the stack's name or its unique stack ID.</p></li>
/// <li>
/// <p>Deleted stacks: You must specify the unique stack ID.</p></li>
/// </ul>
/// <p>Default: There is no default value.</p>
/// <p>Required: Conditional. If you don't specify <code>StackName</code>, you must specify <code>PhysicalResourceId</code>.</p>
pub fn stack_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.stack_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:</p>
/// <ul>
/// <li>
/// <p>Running stacks: You can specify either the stack's name or its unique stack ID.</p></li>
/// <li>
/// <p>Deleted stacks: You must specify the unique stack ID.</p></li>
/// </ul>
/// <p>Default: There is no default value.</p>
/// <p>Required: Conditional. If you don't specify <code>StackName</code>, you must specify <code>PhysicalResourceId</code>.</p>
pub fn set_stack_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.stack_name = input;
self
}
/// <p>The name or the unique stack ID that is associated with the stack, which aren't always interchangeable:</p>
/// <ul>
/// <li>
/// <p>Running stacks: You can specify either the stack's name or its unique stack ID.</p></li>
/// <li>
/// <p>Deleted stacks: You must specify the unique stack ID.</p></li>
/// </ul>
/// <p>Default: There is no default value.</p>
/// <p>Required: Conditional. If you don't specify <code>StackName</code>, you must specify <code>PhysicalResourceId</code>.</p>
pub fn get_stack_name(&self) -> &::std::option::Option<::std::string::String> {
&self.stack_name
}
/// <p>The logical name of the resource as specified in the template.</p>
/// <p>Default: There is no default value.</p>
pub fn logical_resource_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.logical_resource_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The logical name of the resource as specified in the template.</p>
/// <p>Default: There is no default value.</p>
pub fn set_logical_resource_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.logical_resource_id = input;
self
}
/// <p>The logical name of the resource as specified in the template.</p>
/// <p>Default: There is no default value.</p>
pub fn get_logical_resource_id(&self) -> &::std::option::Option<::std::string::String> {
&self.logical_resource_id
}
/// <p>The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.</p>
/// <p>For example, for an Amazon Elastic Compute Cloud (EC2) instance, <code>PhysicalResourceId</code> corresponds to the <code>InstanceId</code>. You can pass the EC2 <code>InstanceId</code> to <code>DescribeStackResources</code> to find which stack the instance belongs to and what other resources are part of the stack.</p>
/// <p>Required: Conditional. If you don't specify <code>PhysicalResourceId</code>, you must specify <code>StackName</code>.</p>
/// <p>Default: There is no default value.</p>
pub fn physical_resource_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.physical_resource_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.</p>
/// <p>For example, for an Amazon Elastic Compute Cloud (EC2) instance, <code>PhysicalResourceId</code> corresponds to the <code>InstanceId</code>. You can pass the EC2 <code>InstanceId</code> to <code>DescribeStackResources</code> to find which stack the instance belongs to and what other resources are part of the stack.</p>
/// <p>Required: Conditional. If you don't specify <code>PhysicalResourceId</code>, you must specify <code>StackName</code>.</p>
/// <p>Default: There is no default value.</p>
pub fn set_physical_resource_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.physical_resource_id = input;
self
}
/// <p>The name or unique identifier that corresponds to a physical instance ID of a resource supported by CloudFormation.</p>
/// <p>For example, for an Amazon Elastic Compute Cloud (EC2) instance, <code>PhysicalResourceId</code> corresponds to the <code>InstanceId</code>. You can pass the EC2 <code>InstanceId</code> to <code>DescribeStackResources</code> to find which stack the instance belongs to and what other resources are part of the stack.</p>
/// <p>Required: Conditional. If you don't specify <code>PhysicalResourceId</code>, you must specify <code>StackName</code>.</p>
/// <p>Default: There is no default value.</p>
pub fn get_physical_resource_id(&self) -> &::std::option::Option<::std::string::String> {
&self.physical_resource_id
}
/// Consumes the builder and constructs a [`DescribeStackResourcesInput`](crate::operation::describe_stack_resources::DescribeStackResourcesInput).
pub fn build(
self,
) -> ::std::result::Result<
crate::operation::describe_stack_resources::DescribeStackResourcesInput,
::aws_smithy_types::error::operation::BuildError,
> {
::std::result::Result::Ok(crate::operation::describe_stack_resources::DescribeStackResourcesInput {
stack_name: self.stack_name,
logical_resource_id: self.logical_resource_id,
physical_resource_id: self.physical_resource_id,
})
}
}