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 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
// 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)]
pub struct UpdatePipeInput {
/// <p>The name of the pipe.</p>
pub name: ::std::option::Option<::std::string::String>,
/// <p>A description of the pipe.</p>
pub description: ::std::option::Option<::std::string::String>,
/// <p>The state the pipe should be in.</p>
pub desired_state: ::std::option::Option<crate::types::RequestedPipeState>,
/// <p>The parameters required to set up a source for your pipe.</p>
pub source_parameters: ::std::option::Option<crate::types::UpdatePipeSourceParameters>,
/// <p>The ARN of the enrichment resource.</p>
pub enrichment: ::std::option::Option<::std::string::String>,
/// <p>The parameters required to set up enrichment on your pipe.</p>
pub enrichment_parameters: ::std::option::Option<crate::types::PipeEnrichmentParameters>,
/// <p>The ARN of the target resource.</p>
pub target: ::std::option::Option<::std::string::String>,
/// <p>The parameters required to set up a target for your pipe.</p>
/// <p>For more information about pipe target parameters, including how to use dynamic path parameters, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html">Target parameters</a> in the <i>Amazon EventBridge User Guide</i>.</p>
pub target_parameters: ::std::option::Option<crate::types::PipeTargetParameters>,
/// <p>The ARN of the role that allows the pipe to send data to the target.</p>
pub role_arn: ::std::option::Option<::std::string::String>,
/// <p>The logging configuration settings for the pipe.</p>
pub log_configuration: ::std::option::Option<crate::types::PipeLogConfigurationParameters>,
/// <p>The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.</p>
/// <p>To update a pipe that is using the default Amazon Web Services owned key to use a customer managed key instead, or update a pipe that is using a customer managed key to use a different customer managed key, specify a customer managed key identifier.</p>
/// <p>To update a pipe that is using a customer managed key to use the default Amazon Web Services owned key, specify an empty string.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/getting-started.html">Managing keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
pub kms_key_identifier: ::std::option::Option<::std::string::String>,
}
impl UpdatePipeInput {
/// <p>The name of the pipe.</p>
pub fn name(&self) -> ::std::option::Option<&str> {
self.name.as_deref()
}
/// <p>A description of the pipe.</p>
pub fn description(&self) -> ::std::option::Option<&str> {
self.description.as_deref()
}
/// <p>The state the pipe should be in.</p>
pub fn desired_state(&self) -> ::std::option::Option<&crate::types::RequestedPipeState> {
self.desired_state.as_ref()
}
/// <p>The parameters required to set up a source for your pipe.</p>
pub fn source_parameters(&self) -> ::std::option::Option<&crate::types::UpdatePipeSourceParameters> {
self.source_parameters.as_ref()
}
/// <p>The ARN of the enrichment resource.</p>
pub fn enrichment(&self) -> ::std::option::Option<&str> {
self.enrichment.as_deref()
}
/// <p>The parameters required to set up enrichment on your pipe.</p>
pub fn enrichment_parameters(&self) -> ::std::option::Option<&crate::types::PipeEnrichmentParameters> {
self.enrichment_parameters.as_ref()
}
/// <p>The ARN of the target resource.</p>
pub fn target(&self) -> ::std::option::Option<&str> {
self.target.as_deref()
}
/// <p>The parameters required to set up a target for your pipe.</p>
/// <p>For more information about pipe target parameters, including how to use dynamic path parameters, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html">Target parameters</a> in the <i>Amazon EventBridge User Guide</i>.</p>
pub fn target_parameters(&self) -> ::std::option::Option<&crate::types::PipeTargetParameters> {
self.target_parameters.as_ref()
}
/// <p>The ARN of the role that allows the pipe to send data to the target.</p>
pub fn role_arn(&self) -> ::std::option::Option<&str> {
self.role_arn.as_deref()
}
/// <p>The logging configuration settings for the pipe.</p>
pub fn log_configuration(&self) -> ::std::option::Option<&crate::types::PipeLogConfigurationParameters> {
self.log_configuration.as_ref()
}
/// <p>The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.</p>
/// <p>To update a pipe that is using the default Amazon Web Services owned key to use a customer managed key instead, or update a pipe that is using a customer managed key to use a different customer managed key, specify a customer managed key identifier.</p>
/// <p>To update a pipe that is using a customer managed key to use the default Amazon Web Services owned key, specify an empty string.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/getting-started.html">Managing keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
pub fn kms_key_identifier(&self) -> ::std::option::Option<&str> {
self.kms_key_identifier.as_deref()
}
}
impl ::std::fmt::Debug for UpdatePipeInput {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
let mut formatter = f.debug_struct("UpdatePipeInput");
formatter.field("name", &self.name);
formatter.field("description", &"*** Sensitive Data Redacted ***");
formatter.field("desired_state", &self.desired_state);
formatter.field("source_parameters", &self.source_parameters);
formatter.field("enrichment", &self.enrichment);
formatter.field("enrichment_parameters", &self.enrichment_parameters);
formatter.field("target", &self.target);
formatter.field("target_parameters", &self.target_parameters);
formatter.field("role_arn", &self.role_arn);
formatter.field("log_configuration", &self.log_configuration);
formatter.field("kms_key_identifier", &self.kms_key_identifier);
formatter.finish()
}
}
impl UpdatePipeInput {
/// Creates a new builder-style object to manufacture [`UpdatePipeInput`](crate::operation::update_pipe::UpdatePipeInput).
pub fn builder() -> crate::operation::update_pipe::builders::UpdatePipeInputBuilder {
crate::operation::update_pipe::builders::UpdatePipeInputBuilder::default()
}
}
/// A builder for [`UpdatePipeInput`](crate::operation::update_pipe::UpdatePipeInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
#[non_exhaustive]
pub struct UpdatePipeInputBuilder {
pub(crate) name: ::std::option::Option<::std::string::String>,
pub(crate) description: ::std::option::Option<::std::string::String>,
pub(crate) desired_state: ::std::option::Option<crate::types::RequestedPipeState>,
pub(crate) source_parameters: ::std::option::Option<crate::types::UpdatePipeSourceParameters>,
pub(crate) enrichment: ::std::option::Option<::std::string::String>,
pub(crate) enrichment_parameters: ::std::option::Option<crate::types::PipeEnrichmentParameters>,
pub(crate) target: ::std::option::Option<::std::string::String>,
pub(crate) target_parameters: ::std::option::Option<crate::types::PipeTargetParameters>,
pub(crate) role_arn: ::std::option::Option<::std::string::String>,
pub(crate) log_configuration: ::std::option::Option<crate::types::PipeLogConfigurationParameters>,
pub(crate) kms_key_identifier: ::std::option::Option<::std::string::String>,
}
impl UpdatePipeInputBuilder {
/// <p>The name of the pipe.</p>
/// This field is required.
pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the pipe.</p>
pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.name = input;
self
}
/// <p>The name of the pipe.</p>
pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
&self.name
}
/// <p>A description of the pipe.</p>
pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.description = ::std::option::Option::Some(input.into());
self
}
/// <p>A description of the pipe.</p>
pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.description = input;
self
}
/// <p>A description of the pipe.</p>
pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
&self.description
}
/// <p>The state the pipe should be in.</p>
pub fn desired_state(mut self, input: crate::types::RequestedPipeState) -> Self {
self.desired_state = ::std::option::Option::Some(input);
self
}
/// <p>The state the pipe should be in.</p>
pub fn set_desired_state(mut self, input: ::std::option::Option<crate::types::RequestedPipeState>) -> Self {
self.desired_state = input;
self
}
/// <p>The state the pipe should be in.</p>
pub fn get_desired_state(&self) -> &::std::option::Option<crate::types::RequestedPipeState> {
&self.desired_state
}
/// <p>The parameters required to set up a source for your pipe.</p>
pub fn source_parameters(mut self, input: crate::types::UpdatePipeSourceParameters) -> Self {
self.source_parameters = ::std::option::Option::Some(input);
self
}
/// <p>The parameters required to set up a source for your pipe.</p>
pub fn set_source_parameters(mut self, input: ::std::option::Option<crate::types::UpdatePipeSourceParameters>) -> Self {
self.source_parameters = input;
self
}
/// <p>The parameters required to set up a source for your pipe.</p>
pub fn get_source_parameters(&self) -> &::std::option::Option<crate::types::UpdatePipeSourceParameters> {
&self.source_parameters
}
/// <p>The ARN of the enrichment resource.</p>
pub fn enrichment(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.enrichment = ::std::option::Option::Some(input.into());
self
}
/// <p>The ARN of the enrichment resource.</p>
pub fn set_enrichment(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.enrichment = input;
self
}
/// <p>The ARN of the enrichment resource.</p>
pub fn get_enrichment(&self) -> &::std::option::Option<::std::string::String> {
&self.enrichment
}
/// <p>The parameters required to set up enrichment on your pipe.</p>
pub fn enrichment_parameters(mut self, input: crate::types::PipeEnrichmentParameters) -> Self {
self.enrichment_parameters = ::std::option::Option::Some(input);
self
}
/// <p>The parameters required to set up enrichment on your pipe.</p>
pub fn set_enrichment_parameters(mut self, input: ::std::option::Option<crate::types::PipeEnrichmentParameters>) -> Self {
self.enrichment_parameters = input;
self
}
/// <p>The parameters required to set up enrichment on your pipe.</p>
pub fn get_enrichment_parameters(&self) -> &::std::option::Option<crate::types::PipeEnrichmentParameters> {
&self.enrichment_parameters
}
/// <p>The ARN of the target resource.</p>
pub fn target(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.target = ::std::option::Option::Some(input.into());
self
}
/// <p>The ARN of the target resource.</p>
pub fn set_target(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.target = input;
self
}
/// <p>The ARN of the target resource.</p>
pub fn get_target(&self) -> &::std::option::Option<::std::string::String> {
&self.target
}
/// <p>The parameters required to set up a target for your pipe.</p>
/// <p>For more information about pipe target parameters, including how to use dynamic path parameters, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html">Target parameters</a> in the <i>Amazon EventBridge User Guide</i>.</p>
pub fn target_parameters(mut self, input: crate::types::PipeTargetParameters) -> Self {
self.target_parameters = ::std::option::Option::Some(input);
self
}
/// <p>The parameters required to set up a target for your pipe.</p>
/// <p>For more information about pipe target parameters, including how to use dynamic path parameters, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html">Target parameters</a> in the <i>Amazon EventBridge User Guide</i>.</p>
pub fn set_target_parameters(mut self, input: ::std::option::Option<crate::types::PipeTargetParameters>) -> Self {
self.target_parameters = input;
self
}
/// <p>The parameters required to set up a target for your pipe.</p>
/// <p>For more information about pipe target parameters, including how to use dynamic path parameters, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html">Target parameters</a> in the <i>Amazon EventBridge User Guide</i>.</p>
pub fn get_target_parameters(&self) -> &::std::option::Option<crate::types::PipeTargetParameters> {
&self.target_parameters
}
/// <p>The ARN of the role that allows the pipe to send data to the target.</p>
/// This field is required.
pub fn role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.role_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The ARN of the role that allows the pipe to send data to the target.</p>
pub fn set_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.role_arn = input;
self
}
/// <p>The ARN of the role that allows the pipe to send data to the target.</p>
pub fn get_role_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.role_arn
}
/// <p>The logging configuration settings for the pipe.</p>
pub fn log_configuration(mut self, input: crate::types::PipeLogConfigurationParameters) -> Self {
self.log_configuration = ::std::option::Option::Some(input);
self
}
/// <p>The logging configuration settings for the pipe.</p>
pub fn set_log_configuration(mut self, input: ::std::option::Option<crate::types::PipeLogConfigurationParameters>) -> Self {
self.log_configuration = input;
self
}
/// <p>The logging configuration settings for the pipe.</p>
pub fn get_log_configuration(&self) -> &::std::option::Option<crate::types::PipeLogConfigurationParameters> {
&self.log_configuration
}
/// <p>The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.</p>
/// <p>To update a pipe that is using the default Amazon Web Services owned key to use a customer managed key instead, or update a pipe that is using a customer managed key to use a different customer managed key, specify a customer managed key identifier.</p>
/// <p>To update a pipe that is using a customer managed key to use the default Amazon Web Services owned key, specify an empty string.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/getting-started.html">Managing keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
pub fn kms_key_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.kms_key_identifier = ::std::option::Option::Some(input.into());
self
}
/// <p>The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.</p>
/// <p>To update a pipe that is using the default Amazon Web Services owned key to use a customer managed key instead, or update a pipe that is using a customer managed key to use a different customer managed key, specify a customer managed key identifier.</p>
/// <p>To update a pipe that is using a customer managed key to use the default Amazon Web Services owned key, specify an empty string.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/getting-started.html">Managing keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
pub fn set_kms_key_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.kms_key_identifier = input;
self
}
/// <p>The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.</p>
/// <p>To update a pipe that is using the default Amazon Web Services owned key to use a customer managed key instead, or update a pipe that is using a customer managed key to use a different customer managed key, specify a customer managed key identifier.</p>
/// <p>To update a pipe that is using a customer managed key to use the default Amazon Web Services owned key, specify an empty string.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/getting-started.html">Managing keys</a> in the <i>Key Management Service Developer Guide</i>.</p>
pub fn get_kms_key_identifier(&self) -> &::std::option::Option<::std::string::String> {
&self.kms_key_identifier
}
/// Consumes the builder and constructs a [`UpdatePipeInput`](crate::operation::update_pipe::UpdatePipeInput).
pub fn build(self) -> ::std::result::Result<crate::operation::update_pipe::UpdatePipeInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::update_pipe::UpdatePipeInput {
name: self.name,
description: self.description,
desired_state: self.desired_state,
source_parameters: self.source_parameters,
enrichment: self.enrichment,
enrichment_parameters: self.enrichment_parameters,
target: self.target,
target_parameters: self.target_parameters,
role_arn: self.role_arn,
log_configuration: self.log_configuration,
kms_key_identifier: self.kms_key_identifier,
})
}
}
impl ::std::fmt::Debug for UpdatePipeInputBuilder {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
let mut formatter = f.debug_struct("UpdatePipeInputBuilder");
formatter.field("name", &self.name);
formatter.field("description", &"*** Sensitive Data Redacted ***");
formatter.field("desired_state", &self.desired_state);
formatter.field("source_parameters", &self.source_parameters);
formatter.field("enrichment", &self.enrichment);
formatter.field("enrichment_parameters", &self.enrichment_parameters);
formatter.field("target", &self.target);
formatter.field("target_parameters", &self.target_parameters);
formatter.field("role_arn", &self.role_arn);
formatter.field("log_configuration", &self.log_configuration);
formatter.field("kms_key_identifier", &self.kms_key_identifier);
formatter.finish()
}
}