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 326 327 328 329
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
/// <p></p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct DescribeEventsInput {
/// <p>The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.</p>
/// <p>Constraints:</p>
/// <p>If <i>SourceIdentifier</i> is supplied, <i>SourceType</i> must also be provided.</p>
/// <ul>
/// <li>
/// <p>Specify a cluster identifier when <i>SourceType</i> is <code>cluster</code>.</p></li>
/// <li>
/// <p>Specify a cluster security group name when <i>SourceType</i> is <code>cluster-security-group</code>.</p></li>
/// <li>
/// <p>Specify a cluster parameter group name when <i>SourceType</i> is <code>cluster-parameter-group</code>.</p></li>
/// <li>
/// <p>Specify a cluster snapshot identifier when <i>SourceType</i> is <code>cluster-snapshot</code>.</p></li>
/// </ul>
pub source_identifier: ::std::option::Option<::std::string::String>,
/// <p>The event source to retrieve events for. If no value is specified, all events are returned.</p>
/// <p>Constraints:</p>
/// <p>If <i>SourceType</i> is supplied, <i>SourceIdentifier</i> must also be provided.</p>
/// <ul>
/// <li>
/// <p>Specify <code>cluster</code> when <i>SourceIdentifier</i> is a cluster identifier.</p></li>
/// <li>
/// <p>Specify <code>cluster-security-group</code> when <i>SourceIdentifier</i> is a cluster security group name.</p></li>
/// <li>
/// <p>Specify <code>cluster-parameter-group</code> when <i>SourceIdentifier</i> is a cluster parameter group name.</p></li>
/// <li>
/// <p>Specify <code>cluster-snapshot</code> when <i>SourceIdentifier</i> is a cluster snapshot identifier.</p></li>
/// </ul>
pub source_type: ::std::option::Option<crate::types::SourceType>,
/// <p>The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a></p>
/// <p>Example: <code>2009-07-08T18:00Z</code></p>
pub start_time: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a></p>
/// <p>Example: <code>2009-07-08T18:00Z</code></p>
pub end_time: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.</p>
/// <p>Default: <code>60</code></p>
pub duration: ::std::option::Option<i32>,
/// <p>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.</p>
/// <p>Default: <code>100</code></p>
/// <p>Constraints: minimum 20, maximum 100.</p>
pub max_records: ::std::option::Option<i32>,
/// <p>An optional parameter that specifies the starting point to return a set of response records. When the results of a <code>DescribeEvents</code> request exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request.</p>
pub marker: ::std::option::Option<::std::string::String>,
}
impl DescribeEventsInput {
/// <p>The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.</p>
/// <p>Constraints:</p>
/// <p>If <i>SourceIdentifier</i> is supplied, <i>SourceType</i> must also be provided.</p>
/// <ul>
/// <li>
/// <p>Specify a cluster identifier when <i>SourceType</i> is <code>cluster</code>.</p></li>
/// <li>
/// <p>Specify a cluster security group name when <i>SourceType</i> is <code>cluster-security-group</code>.</p></li>
/// <li>
/// <p>Specify a cluster parameter group name when <i>SourceType</i> is <code>cluster-parameter-group</code>.</p></li>
/// <li>
/// <p>Specify a cluster snapshot identifier when <i>SourceType</i> is <code>cluster-snapshot</code>.</p></li>
/// </ul>
pub fn source_identifier(&self) -> ::std::option::Option<&str> {
self.source_identifier.as_deref()
}
/// <p>The event source to retrieve events for. If no value is specified, all events are returned.</p>
/// <p>Constraints:</p>
/// <p>If <i>SourceType</i> is supplied, <i>SourceIdentifier</i> must also be provided.</p>
/// <ul>
/// <li>
/// <p>Specify <code>cluster</code> when <i>SourceIdentifier</i> is a cluster identifier.</p></li>
/// <li>
/// <p>Specify <code>cluster-security-group</code> when <i>SourceIdentifier</i> is a cluster security group name.</p></li>
/// <li>
/// <p>Specify <code>cluster-parameter-group</code> when <i>SourceIdentifier</i> is a cluster parameter group name.</p></li>
/// <li>
/// <p>Specify <code>cluster-snapshot</code> when <i>SourceIdentifier</i> is a cluster snapshot identifier.</p></li>
/// </ul>
pub fn source_type(&self) -> ::std::option::Option<&crate::types::SourceType> {
self.source_type.as_ref()
}
/// <p>The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a></p>
/// <p>Example: <code>2009-07-08T18:00Z</code></p>
pub fn start_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.start_time.as_ref()
}
/// <p>The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a></p>
/// <p>Example: <code>2009-07-08T18:00Z</code></p>
pub fn end_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.end_time.as_ref()
}
/// <p>The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.</p>
/// <p>Default: <code>60</code></p>
pub fn duration(&self) -> ::std::option::Option<i32> {
self.duration
}
/// <p>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.</p>
/// <p>Default: <code>100</code></p>
/// <p>Constraints: minimum 20, maximum 100.</p>
pub fn max_records(&self) -> ::std::option::Option<i32> {
self.max_records
}
/// <p>An optional parameter that specifies the starting point to return a set of response records. When the results of a <code>DescribeEvents</code> request exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request.</p>
pub fn marker(&self) -> ::std::option::Option<&str> {
self.marker.as_deref()
}
}
impl DescribeEventsInput {
/// Creates a new builder-style object to manufacture [`DescribeEventsInput`](crate::operation::describe_events::DescribeEventsInput).
pub fn builder() -> crate::operation::describe_events::builders::DescribeEventsInputBuilder {
crate::operation::describe_events::builders::DescribeEventsInputBuilder::default()
}
}
/// A builder for [`DescribeEventsInput`](crate::operation::describe_events::DescribeEventsInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct DescribeEventsInputBuilder {
pub(crate) source_identifier: ::std::option::Option<::std::string::String>,
pub(crate) source_type: ::std::option::Option<crate::types::SourceType>,
pub(crate) start_time: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) end_time: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) duration: ::std::option::Option<i32>,
pub(crate) max_records: ::std::option::Option<i32>,
pub(crate) marker: ::std::option::Option<::std::string::String>,
}
impl DescribeEventsInputBuilder {
/// <p>The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.</p>
/// <p>Constraints:</p>
/// <p>If <i>SourceIdentifier</i> is supplied, <i>SourceType</i> must also be provided.</p>
/// <ul>
/// <li>
/// <p>Specify a cluster identifier when <i>SourceType</i> is <code>cluster</code>.</p></li>
/// <li>
/// <p>Specify a cluster security group name when <i>SourceType</i> is <code>cluster-security-group</code>.</p></li>
/// <li>
/// <p>Specify a cluster parameter group name when <i>SourceType</i> is <code>cluster-parameter-group</code>.</p></li>
/// <li>
/// <p>Specify a cluster snapshot identifier when <i>SourceType</i> is <code>cluster-snapshot</code>.</p></li>
/// </ul>
pub fn source_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.source_identifier = ::std::option::Option::Some(input.into());
self
}
/// <p>The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.</p>
/// <p>Constraints:</p>
/// <p>If <i>SourceIdentifier</i> is supplied, <i>SourceType</i> must also be provided.</p>
/// <ul>
/// <li>
/// <p>Specify a cluster identifier when <i>SourceType</i> is <code>cluster</code>.</p></li>
/// <li>
/// <p>Specify a cluster security group name when <i>SourceType</i> is <code>cluster-security-group</code>.</p></li>
/// <li>
/// <p>Specify a cluster parameter group name when <i>SourceType</i> is <code>cluster-parameter-group</code>.</p></li>
/// <li>
/// <p>Specify a cluster snapshot identifier when <i>SourceType</i> is <code>cluster-snapshot</code>.</p></li>
/// </ul>
pub fn set_source_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.source_identifier = input;
self
}
/// <p>The identifier of the event source for which events will be returned. If this parameter is not specified, then all sources are included in the response.</p>
/// <p>Constraints:</p>
/// <p>If <i>SourceIdentifier</i> is supplied, <i>SourceType</i> must also be provided.</p>
/// <ul>
/// <li>
/// <p>Specify a cluster identifier when <i>SourceType</i> is <code>cluster</code>.</p></li>
/// <li>
/// <p>Specify a cluster security group name when <i>SourceType</i> is <code>cluster-security-group</code>.</p></li>
/// <li>
/// <p>Specify a cluster parameter group name when <i>SourceType</i> is <code>cluster-parameter-group</code>.</p></li>
/// <li>
/// <p>Specify a cluster snapshot identifier when <i>SourceType</i> is <code>cluster-snapshot</code>.</p></li>
/// </ul>
pub fn get_source_identifier(&self) -> &::std::option::Option<::std::string::String> {
&self.source_identifier
}
/// <p>The event source to retrieve events for. If no value is specified, all events are returned.</p>
/// <p>Constraints:</p>
/// <p>If <i>SourceType</i> is supplied, <i>SourceIdentifier</i> must also be provided.</p>
/// <ul>
/// <li>
/// <p>Specify <code>cluster</code> when <i>SourceIdentifier</i> is a cluster identifier.</p></li>
/// <li>
/// <p>Specify <code>cluster-security-group</code> when <i>SourceIdentifier</i> is a cluster security group name.</p></li>
/// <li>
/// <p>Specify <code>cluster-parameter-group</code> when <i>SourceIdentifier</i> is a cluster parameter group name.</p></li>
/// <li>
/// <p>Specify <code>cluster-snapshot</code> when <i>SourceIdentifier</i> is a cluster snapshot identifier.</p></li>
/// </ul>
pub fn source_type(mut self, input: crate::types::SourceType) -> Self {
self.source_type = ::std::option::Option::Some(input);
self
}
/// <p>The event source to retrieve events for. If no value is specified, all events are returned.</p>
/// <p>Constraints:</p>
/// <p>If <i>SourceType</i> is supplied, <i>SourceIdentifier</i> must also be provided.</p>
/// <ul>
/// <li>
/// <p>Specify <code>cluster</code> when <i>SourceIdentifier</i> is a cluster identifier.</p></li>
/// <li>
/// <p>Specify <code>cluster-security-group</code> when <i>SourceIdentifier</i> is a cluster security group name.</p></li>
/// <li>
/// <p>Specify <code>cluster-parameter-group</code> when <i>SourceIdentifier</i> is a cluster parameter group name.</p></li>
/// <li>
/// <p>Specify <code>cluster-snapshot</code> when <i>SourceIdentifier</i> is a cluster snapshot identifier.</p></li>
/// </ul>
pub fn set_source_type(mut self, input: ::std::option::Option<crate::types::SourceType>) -> Self {
self.source_type = input;
self
}
/// <p>The event source to retrieve events for. If no value is specified, all events are returned.</p>
/// <p>Constraints:</p>
/// <p>If <i>SourceType</i> is supplied, <i>SourceIdentifier</i> must also be provided.</p>
/// <ul>
/// <li>
/// <p>Specify <code>cluster</code> when <i>SourceIdentifier</i> is a cluster identifier.</p></li>
/// <li>
/// <p>Specify <code>cluster-security-group</code> when <i>SourceIdentifier</i> is a cluster security group name.</p></li>
/// <li>
/// <p>Specify <code>cluster-parameter-group</code> when <i>SourceIdentifier</i> is a cluster parameter group name.</p></li>
/// <li>
/// <p>Specify <code>cluster-snapshot</code> when <i>SourceIdentifier</i> is a cluster snapshot identifier.</p></li>
/// </ul>
pub fn get_source_type(&self) -> &::std::option::Option<crate::types::SourceType> {
&self.source_type
}
/// <p>The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a></p>
/// <p>Example: <code>2009-07-08T18:00Z</code></p>
pub fn start_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.start_time = ::std::option::Option::Some(input);
self
}
/// <p>The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a></p>
/// <p>Example: <code>2009-07-08T18:00Z</code></p>
pub fn set_start_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.start_time = input;
self
}
/// <p>The beginning of the time interval to retrieve events for, specified in ISO 8601 format. For more information about ISO 8601, go to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a></p>
/// <p>Example: <code>2009-07-08T18:00Z</code></p>
pub fn get_start_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.start_time
}
/// <p>The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a></p>
/// <p>Example: <code>2009-07-08T18:00Z</code></p>
pub fn end_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.end_time = ::std::option::Option::Some(input);
self
}
/// <p>The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a></p>
/// <p>Example: <code>2009-07-08T18:00Z</code></p>
pub fn set_end_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.end_time = input;
self
}
/// <p>The end of the time interval for which to retrieve events, specified in ISO 8601 format. For more information about ISO 8601, go to the <a href="http://en.wikipedia.org/wiki/ISO_8601">ISO8601 Wikipedia page.</a></p>
/// <p>Example: <code>2009-07-08T18:00Z</code></p>
pub fn get_end_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.end_time
}
/// <p>The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.</p>
/// <p>Default: <code>60</code></p>
pub fn duration(mut self, input: i32) -> Self {
self.duration = ::std::option::Option::Some(input);
self
}
/// <p>The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.</p>
/// <p>Default: <code>60</code></p>
pub fn set_duration(mut self, input: ::std::option::Option<i32>) -> Self {
self.duration = input;
self
}
/// <p>The number of minutes prior to the time of the request for which to retrieve events. For example, if the request is sent at 18:00 and you specify a duration of 60, then only events which have occurred after 17:00 will be returned.</p>
/// <p>Default: <code>60</code></p>
pub fn get_duration(&self) -> &::std::option::Option<i32> {
&self.duration
}
/// <p>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.</p>
/// <p>Default: <code>100</code></p>
/// <p>Constraints: minimum 20, maximum 100.</p>
pub fn max_records(mut self, input: i32) -> Self {
self.max_records = ::std::option::Option::Some(input);
self
}
/// <p>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.</p>
/// <p>Default: <code>100</code></p>
/// <p>Constraints: minimum 20, maximum 100.</p>
pub fn set_max_records(mut self, input: ::std::option::Option<i32>) -> Self {
self.max_records = input;
self
}
/// <p>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.</p>
/// <p>Default: <code>100</code></p>
/// <p>Constraints: minimum 20, maximum 100.</p>
pub fn get_max_records(&self) -> &::std::option::Option<i32> {
&self.max_records
}
/// <p>An optional parameter that specifies the starting point to return a set of response records. When the results of a <code>DescribeEvents</code> request exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request.</p>
pub fn marker(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.marker = ::std::option::Option::Some(input.into());
self
}
/// <p>An optional parameter that specifies the starting point to return a set of response records. When the results of a <code>DescribeEvents</code> request exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request.</p>
pub fn set_marker(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.marker = input;
self
}
/// <p>An optional parameter that specifies the starting point to return a set of response records. When the results of a <code>DescribeEvents</code> request exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request.</p>
pub fn get_marker(&self) -> &::std::option::Option<::std::string::String> {
&self.marker
}
/// Consumes the builder and constructs a [`DescribeEventsInput`](crate::operation::describe_events::DescribeEventsInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::describe_events::DescribeEventsInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::describe_events::DescribeEventsInput {
source_identifier: self.source_identifier,
source_type: self.source_type,
start_time: self.start_time,
end_time: self.end_time,
duration: self.duration,
max_records: self.max_records,
marker: self.marker,
})
}
}