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
// 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 CreateDeploymentInput {
/// <p>The stack ID.</p>
pub stack_id: ::std::option::Option<::std::string::String>,
/// <p>The app ID. This parameter is required for app deployments, but not for other deployment commands.</p>
pub app_id: ::std::option::Option<::std::string::String>,
/// <p>The instance IDs for the deployment targets.</p>
pub instance_ids: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
/// <p>The layer IDs for the deployment targets.</p>
pub layer_ids: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
/// <p>A <code>DeploymentCommand</code> object that specifies the deployment command and any associated arguments.</p>
pub command: ::std::option::Option<crate::types::DeploymentCommand>,
/// <p>A user-defined comment.</p>
pub comment: ::std::option::Option<::std::string::String>,
/// <p>A string that contains user-defined, custom JSON. You can use this parameter to override some corresponding default stack configuration JSON values. The string should be in the following format:</p>
/// <p><code>"{\"key1\": \"value1\", \"key2\": \"value2\",...}"</code></p>
/// <p>For more information about custom JSON, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html">Use Custom JSON to Modify the Stack Configuration Attributes</a> and <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-json-override.html">Overriding Attributes With Custom JSON</a>.</p>
pub custom_json: ::std::option::Option<::std::string::String>,
}
impl CreateDeploymentInput {
/// <p>The stack ID.</p>
pub fn stack_id(&self) -> ::std::option::Option<&str> {
self.stack_id.as_deref()
}
/// <p>The app ID. This parameter is required for app deployments, but not for other deployment commands.</p>
pub fn app_id(&self) -> ::std::option::Option<&str> {
self.app_id.as_deref()
}
/// <p>The instance IDs for the deployment targets.</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 `.instance_ids.is_none()`.
pub fn instance_ids(&self) -> &[::std::string::String] {
self.instance_ids.as_deref().unwrap_or_default()
}
/// <p>The layer IDs for the deployment targets.</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 `.layer_ids.is_none()`.
pub fn layer_ids(&self) -> &[::std::string::String] {
self.layer_ids.as_deref().unwrap_or_default()
}
/// <p>A <code>DeploymentCommand</code> object that specifies the deployment command and any associated arguments.</p>
pub fn command(&self) -> ::std::option::Option<&crate::types::DeploymentCommand> {
self.command.as_ref()
}
/// <p>A user-defined comment.</p>
pub fn comment(&self) -> ::std::option::Option<&str> {
self.comment.as_deref()
}
/// <p>A string that contains user-defined, custom JSON. You can use this parameter to override some corresponding default stack configuration JSON values. The string should be in the following format:</p>
/// <p><code>"{\"key1\": \"value1\", \"key2\": \"value2\",...}"</code></p>
/// <p>For more information about custom JSON, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html">Use Custom JSON to Modify the Stack Configuration Attributes</a> and <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-json-override.html">Overriding Attributes With Custom JSON</a>.</p>
pub fn custom_json(&self) -> ::std::option::Option<&str> {
self.custom_json.as_deref()
}
}
impl CreateDeploymentInput {
/// Creates a new builder-style object to manufacture [`CreateDeploymentInput`](crate::operation::create_deployment::CreateDeploymentInput).
pub fn builder() -> crate::operation::create_deployment::builders::CreateDeploymentInputBuilder {
crate::operation::create_deployment::builders::CreateDeploymentInputBuilder::default()
}
}
/// A builder for [`CreateDeploymentInput`](crate::operation::create_deployment::CreateDeploymentInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct CreateDeploymentInputBuilder {
pub(crate) stack_id: ::std::option::Option<::std::string::String>,
pub(crate) app_id: ::std::option::Option<::std::string::String>,
pub(crate) instance_ids: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
pub(crate) layer_ids: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
pub(crate) command: ::std::option::Option<crate::types::DeploymentCommand>,
pub(crate) comment: ::std::option::Option<::std::string::String>,
pub(crate) custom_json: ::std::option::Option<::std::string::String>,
}
impl CreateDeploymentInputBuilder {
/// <p>The stack ID.</p>
/// This field is required.
pub fn stack_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.stack_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The stack ID.</p>
pub fn set_stack_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.stack_id = input;
self
}
/// <p>The stack ID.</p>
pub fn get_stack_id(&self) -> &::std::option::Option<::std::string::String> {
&self.stack_id
}
/// <p>The app ID. This parameter is required for app deployments, but not for other deployment commands.</p>
pub fn app_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.app_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The app ID. This parameter is required for app deployments, but not for other deployment commands.</p>
pub fn set_app_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.app_id = input;
self
}
/// <p>The app ID. This parameter is required for app deployments, but not for other deployment commands.</p>
pub fn get_app_id(&self) -> &::std::option::Option<::std::string::String> {
&self.app_id
}
/// Appends an item to `instance_ids`.
///
/// To override the contents of this collection use [`set_instance_ids`](Self::set_instance_ids).
///
/// <p>The instance IDs for the deployment targets.</p>
pub fn instance_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.instance_ids.unwrap_or_default();
v.push(input.into());
self.instance_ids = ::std::option::Option::Some(v);
self
}
/// <p>The instance IDs for the deployment targets.</p>
pub fn set_instance_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.instance_ids = input;
self
}
/// <p>The instance IDs for the deployment targets.</p>
pub fn get_instance_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.instance_ids
}
/// Appends an item to `layer_ids`.
///
/// To override the contents of this collection use [`set_layer_ids`](Self::set_layer_ids).
///
/// <p>The layer IDs for the deployment targets.</p>
pub fn layer_ids(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.layer_ids.unwrap_or_default();
v.push(input.into());
self.layer_ids = ::std::option::Option::Some(v);
self
}
/// <p>The layer IDs for the deployment targets.</p>
pub fn set_layer_ids(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.layer_ids = input;
self
}
/// <p>The layer IDs for the deployment targets.</p>
pub fn get_layer_ids(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.layer_ids
}
/// <p>A <code>DeploymentCommand</code> object that specifies the deployment command and any associated arguments.</p>
/// This field is required.
pub fn command(mut self, input: crate::types::DeploymentCommand) -> Self {
self.command = ::std::option::Option::Some(input);
self
}
/// <p>A <code>DeploymentCommand</code> object that specifies the deployment command and any associated arguments.</p>
pub fn set_command(mut self, input: ::std::option::Option<crate::types::DeploymentCommand>) -> Self {
self.command = input;
self
}
/// <p>A <code>DeploymentCommand</code> object that specifies the deployment command and any associated arguments.</p>
pub fn get_command(&self) -> &::std::option::Option<crate::types::DeploymentCommand> {
&self.command
}
/// <p>A user-defined comment.</p>
pub fn comment(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.comment = ::std::option::Option::Some(input.into());
self
}
/// <p>A user-defined comment.</p>
pub fn set_comment(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.comment = input;
self
}
/// <p>A user-defined comment.</p>
pub fn get_comment(&self) -> &::std::option::Option<::std::string::String> {
&self.comment
}
/// <p>A string that contains user-defined, custom JSON. You can use this parameter to override some corresponding default stack configuration JSON values. The string should be in the following format:</p>
/// <p><code>"{\"key1\": \"value1\", \"key2\": \"value2\",...}"</code></p>
/// <p>For more information about custom JSON, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html">Use Custom JSON to Modify the Stack Configuration Attributes</a> and <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-json-override.html">Overriding Attributes With Custom JSON</a>.</p>
pub fn custom_json(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.custom_json = ::std::option::Option::Some(input.into());
self
}
/// <p>A string that contains user-defined, custom JSON. You can use this parameter to override some corresponding default stack configuration JSON values. The string should be in the following format:</p>
/// <p><code>"{\"key1\": \"value1\", \"key2\": \"value2\",...}"</code></p>
/// <p>For more information about custom JSON, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html">Use Custom JSON to Modify the Stack Configuration Attributes</a> and <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-json-override.html">Overriding Attributes With Custom JSON</a>.</p>
pub fn set_custom_json(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.custom_json = input;
self
}
/// <p>A string that contains user-defined, custom JSON. You can use this parameter to override some corresponding default stack configuration JSON values. The string should be in the following format:</p>
/// <p><code>"{\"key1\": \"value1\", \"key2\": \"value2\",...}"</code></p>
/// <p>For more information about custom JSON, see <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html">Use Custom JSON to Modify the Stack Configuration Attributes</a> and <a href="https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-json-override.html">Overriding Attributes With Custom JSON</a>.</p>
pub fn get_custom_json(&self) -> &::std::option::Option<::std::string::String> {
&self.custom_json
}
/// Consumes the builder and constructs a [`CreateDeploymentInput`](crate::operation::create_deployment::CreateDeploymentInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::create_deployment::CreateDeploymentInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::create_deployment::CreateDeploymentInput {
stack_id: self.stack_id,
app_id: self.app_id,
instance_ids: self.instance_ids,
layer_ids: self.layer_ids,
command: self.command,
comment: self.comment,
custom_json: self.custom_json,
})
}
}