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 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct DeleteStackInstancesInput {
/// <p>The name or unique ID of the stack set that you want to delete stack instances for.</p>
pub stack_set_name: ::std::option::Option<::std::string::String>,
/// <p>[Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack instances for.</p>
/// <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>
pub accounts: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
/// <p>[Service-managed permissions] The Organizations accounts from which to delete stack instances.</p>
/// <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>
pub deployment_targets: ::std::option::Option<crate::types::DeploymentTargets>,
/// <p>The Amazon Web Services Regions where you want to delete stack set instances.</p>
pub regions: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
/// <p>Preferences for how CloudFormation performs this stack set operation.</p>
pub operation_preferences: ::std::option::Option<crate::types::StackSetOperationPreferences>,
/// <p>Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options">Stack set operation options</a>.</p>
pub retain_stacks: ::std::option::Option<bool>,
/// <p>The unique identifier for this stack set operation.</p>
/// <p>If you don't specify an operation ID, the SDK generates one automatically.</p>
/// <p>The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You can retry stack set operation requests to ensure that CloudFormation successfully received them.</p>
/// <p>Repeating this stack set operation with a new operation ID retries all stack instances whose status is <code>OUTDATED</code>.</p>
pub operation_id: ::std::option::Option<::std::string::String>,
/// <p>[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.</p>
/// <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed permissions.</p>
/// <ul>
/// <li>
/// <p>If you are signed in to the management account, specify <code>SELF</code>.</p></li>
/// <li>
/// <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p>
/// <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p></li>
/// </ul>
pub call_as: ::std::option::Option<crate::types::CallAs>,
}
impl DeleteStackInstancesInput {
/// <p>The name or unique ID of the stack set that you want to delete stack instances for.</p>
pub fn stack_set_name(&self) -> ::std::option::Option<&str> {
self.stack_set_name.as_deref()
}
/// <p>[Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack instances for.</p>
/// <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.accounts.is_none()`.
pub fn accounts(&self) -> &[::std::string::String] {
self.accounts.as_deref().unwrap_or_default()
}
/// <p>[Service-managed permissions] The Organizations accounts from which to delete stack instances.</p>
/// <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>
pub fn deployment_targets(&self) -> ::std::option::Option<&crate::types::DeploymentTargets> {
self.deployment_targets.as_ref()
}
/// <p>The Amazon Web Services Regions where you want to delete stack set instances.</p>
///
/// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.regions.is_none()`.
pub fn regions(&self) -> &[::std::string::String] {
self.regions.as_deref().unwrap_or_default()
}
/// <p>Preferences for how CloudFormation performs this stack set operation.</p>
pub fn operation_preferences(&self) -> ::std::option::Option<&crate::types::StackSetOperationPreferences> {
self.operation_preferences.as_ref()
}
/// <p>Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options">Stack set operation options</a>.</p>
pub fn retain_stacks(&self) -> ::std::option::Option<bool> {
self.retain_stacks
}
/// <p>The unique identifier for this stack set operation.</p>
/// <p>If you don't specify an operation ID, the SDK generates one automatically.</p>
/// <p>The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You can retry stack set operation requests to ensure that CloudFormation successfully received them.</p>
/// <p>Repeating this stack set operation with a new operation ID retries all stack instances whose status is <code>OUTDATED</code>.</p>
pub fn operation_id(&self) -> ::std::option::Option<&str> {
self.operation_id.as_deref()
}
/// <p>[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.</p>
/// <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed permissions.</p>
/// <ul>
/// <li>
/// <p>If you are signed in to the management account, specify <code>SELF</code>.</p></li>
/// <li>
/// <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p>
/// <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p></li>
/// </ul>
pub fn call_as(&self) -> ::std::option::Option<&crate::types::CallAs> {
self.call_as.as_ref()
}
}
impl DeleteStackInstancesInput {
/// Creates a new builder-style object to manufacture [`DeleteStackInstancesInput`](crate::operation::delete_stack_instances::DeleteStackInstancesInput).
pub fn builder() -> crate::operation::delete_stack_instances::builders::DeleteStackInstancesInputBuilder {
crate::operation::delete_stack_instances::builders::DeleteStackInstancesInputBuilder::default()
}
}
/// A builder for [`DeleteStackInstancesInput`](crate::operation::delete_stack_instances::DeleteStackInstancesInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct DeleteStackInstancesInputBuilder {
pub(crate) stack_set_name: ::std::option::Option<::std::string::String>,
pub(crate) accounts: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
pub(crate) deployment_targets: ::std::option::Option<crate::types::DeploymentTargets>,
pub(crate) regions: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
pub(crate) operation_preferences: ::std::option::Option<crate::types::StackSetOperationPreferences>,
pub(crate) retain_stacks: ::std::option::Option<bool>,
pub(crate) operation_id: ::std::option::Option<::std::string::String>,
pub(crate) call_as: ::std::option::Option<crate::types::CallAs>,
}
impl DeleteStackInstancesInputBuilder {
/// <p>The name or unique ID of the stack set that you want to delete stack instances for.</p>
/// This field is required.
pub fn stack_set_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.stack_set_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name or unique ID of the stack set that you want to delete stack instances for.</p>
pub fn set_stack_set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.stack_set_name = input;
self
}
/// <p>The name or unique ID of the stack set that you want to delete stack instances for.</p>
pub fn get_stack_set_name(&self) -> &::std::option::Option<::std::string::String> {
&self.stack_set_name
}
/// Appends an item to `accounts`.
///
/// To override the contents of this collection use [`set_accounts`](Self::set_accounts).
///
/// <p>[Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack instances for.</p>
/// <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>
pub fn accounts(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.accounts.unwrap_or_default();
v.push(input.into());
self.accounts = ::std::option::Option::Some(v);
self
}
/// <p>[Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack instances for.</p>
/// <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>
pub fn set_accounts(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.accounts = input;
self
}
/// <p>[Self-managed permissions] The names of the Amazon Web Services accounts that you want to delete stack instances for.</p>
/// <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>
pub fn get_accounts(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.accounts
}
/// <p>[Service-managed permissions] The Organizations accounts from which to delete stack instances.</p>
/// <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>
pub fn deployment_targets(mut self, input: crate::types::DeploymentTargets) -> Self {
self.deployment_targets = ::std::option::Option::Some(input);
self
}
/// <p>[Service-managed permissions] The Organizations accounts from which to delete stack instances.</p>
/// <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>
pub fn set_deployment_targets(mut self, input: ::std::option::Option<crate::types::DeploymentTargets>) -> Self {
self.deployment_targets = input;
self
}
/// <p>[Service-managed permissions] The Organizations accounts from which to delete stack instances.</p>
/// <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>
pub fn get_deployment_targets(&self) -> &::std::option::Option<crate::types::DeploymentTargets> {
&self.deployment_targets
}
/// Appends an item to `regions`.
///
/// To override the contents of this collection use [`set_regions`](Self::set_regions).
///
/// <p>The Amazon Web Services Regions where you want to delete stack set instances.</p>
pub fn regions(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.regions.unwrap_or_default();
v.push(input.into());
self.regions = ::std::option::Option::Some(v);
self
}
/// <p>The Amazon Web Services Regions where you want to delete stack set instances.</p>
pub fn set_regions(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.regions = input;
self
}
/// <p>The Amazon Web Services Regions where you want to delete stack set instances.</p>
pub fn get_regions(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.regions
}
/// <p>Preferences for how CloudFormation performs this stack set operation.</p>
pub fn operation_preferences(mut self, input: crate::types::StackSetOperationPreferences) -> Self {
self.operation_preferences = ::std::option::Option::Some(input);
self
}
/// <p>Preferences for how CloudFormation performs this stack set operation.</p>
pub fn set_operation_preferences(mut self, input: ::std::option::Option<crate::types::StackSetOperationPreferences>) -> Self {
self.operation_preferences = input;
self
}
/// <p>Preferences for how CloudFormation performs this stack set operation.</p>
pub fn get_operation_preferences(&self) -> &::std::option::Option<crate::types::StackSetOperationPreferences> {
&self.operation_preferences
}
/// <p>Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options">Stack set operation options</a>.</p>
/// This field is required.
pub fn retain_stacks(mut self, input: bool) -> Self {
self.retain_stacks = ::std::option::Option::Some(input);
self
}
/// <p>Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options">Stack set operation options</a>.</p>
pub fn set_retain_stacks(mut self, input: ::std::option::Option<bool>) -> Self {
self.retain_stacks = input;
self
}
/// <p>Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options">Stack set operation options</a>.</p>
pub fn get_retain_stacks(&self) -> &::std::option::Option<bool> {
&self.retain_stacks
}
/// <p>The unique identifier for this stack set operation.</p>
/// <p>If you don't specify an operation ID, the SDK generates one automatically.</p>
/// <p>The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You can retry stack set operation requests to ensure that CloudFormation successfully received them.</p>
/// <p>Repeating this stack set operation with a new operation ID retries all stack instances whose status is <code>OUTDATED</code>.</p>
pub fn operation_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.operation_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The unique identifier for this stack set operation.</p>
/// <p>If you don't specify an operation ID, the SDK generates one automatically.</p>
/// <p>The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You can retry stack set operation requests to ensure that CloudFormation successfully received them.</p>
/// <p>Repeating this stack set operation with a new operation ID retries all stack instances whose status is <code>OUTDATED</code>.</p>
pub fn set_operation_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.operation_id = input;
self
}
/// <p>The unique identifier for this stack set operation.</p>
/// <p>If you don't specify an operation ID, the SDK generates one automatically.</p>
/// <p>The operation ID also functions as an idempotency token, to ensure that CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You can retry stack set operation requests to ensure that CloudFormation successfully received them.</p>
/// <p>Repeating this stack set operation with a new operation ID retries all stack instances whose status is <code>OUTDATED</code>.</p>
pub fn get_operation_id(&self) -> &::std::option::Option<::std::string::String> {
&self.operation_id
}
/// <p>[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.</p>
/// <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed permissions.</p>
/// <ul>
/// <li>
/// <p>If you are signed in to the management account, specify <code>SELF</code>.</p></li>
/// <li>
/// <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p>
/// <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p></li>
/// </ul>
pub fn call_as(mut self, input: crate::types::CallAs) -> Self {
self.call_as = ::std::option::Option::Some(input);
self
}
/// <p>[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.</p>
/// <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed permissions.</p>
/// <ul>
/// <li>
/// <p>If you are signed in to the management account, specify <code>SELF</code>.</p></li>
/// <li>
/// <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p>
/// <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p></li>
/// </ul>
pub fn set_call_as(mut self, input: ::std::option::Option<crate::types::CallAs>) -> Self {
self.call_as = input;
self
}
/// <p>[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.</p>
/// <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed permissions.</p>
/// <ul>
/// <li>
/// <p>If you are signed in to the management account, specify <code>SELF</code>.</p></li>
/// <li>
/// <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p>
/// <p>Your Amazon Web Services account must be registered as a delegated administrator in the management account. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html">Register a delegated administrator</a> in the <i>CloudFormation User Guide</i>.</p></li>
/// </ul>
pub fn get_call_as(&self) -> &::std::option::Option<crate::types::CallAs> {
&self.call_as
}
/// Consumes the builder and constructs a [`DeleteStackInstancesInput`](crate::operation::delete_stack_instances::DeleteStackInstancesInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::delete_stack_instances::DeleteStackInstancesInput, ::aws_smithy_types::error::operation::BuildError>
{
::std::result::Result::Ok(crate::operation::delete_stack_instances::DeleteStackInstancesInput {
stack_set_name: self.stack_set_name,
accounts: self.accounts,
deployment_targets: self.deployment_targets,
regions: self.regions,
operation_preferences: self.operation_preferences,
retain_stacks: self.retain_stacks,
operation_id: self.operation_id,
call_as: self.call_as,
})
}
}