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
// 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 DescribeRuleOutput {
/// <p>The name of the rule.</p>
pub name: ::std::option::Option<::std::string::String>,
/// <p>The Amazon Resource Name (ARN) of the rule.</p>
pub arn: ::std::option::Option<::std::string::String>,
/// <p>The event pattern. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html">Events and Event Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
pub event_pattern: ::std::option::Option<::std::string::String>,
/// <p>The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".</p>
pub schedule_expression: ::std::option::Option<::std::string::String>,
/// <p>Specifies whether the rule is enabled or disabled.</p>
pub state: ::std::option::Option<crate::types::RuleState>,
/// <p>The description of the rule.</p>
pub description: ::std::option::Option<::std::string::String>,
/// <p>The Amazon Resource Name (ARN) of the IAM role associated with the rule.</p>
pub role_arn: ::std::option::Option<::std::string::String>,
/// <p>If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.</p>
pub managed_by: ::std::option::Option<::std::string::String>,
/// <p>The name of the event bus associated with the rule.</p>
pub event_bus_name: ::std::option::Option<::std::string::String>,
/// <p>The account ID of the user that created the rule. If you use <code>PutRule</code> to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for <code>CreatedBy</code> is the account ID as the account that created the rule in the other account.</p>
pub created_by: ::std::option::Option<::std::string::String>,
_request_id: Option<String>,
}
impl DescribeRuleOutput {
/// <p>The name of the rule.</p>
pub fn name(&self) -> ::std::option::Option<&str> {
self.name.as_deref()
}
/// <p>The Amazon Resource Name (ARN) of the rule.</p>
pub fn arn(&self) -> ::std::option::Option<&str> {
self.arn.as_deref()
}
/// <p>The event pattern. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html">Events and Event Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
pub fn event_pattern(&self) -> ::std::option::Option<&str> {
self.event_pattern.as_deref()
}
/// <p>The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".</p>
pub fn schedule_expression(&self) -> ::std::option::Option<&str> {
self.schedule_expression.as_deref()
}
/// <p>Specifies whether the rule is enabled or disabled.</p>
pub fn state(&self) -> ::std::option::Option<&crate::types::RuleState> {
self.state.as_ref()
}
/// <p>The description of the rule.</p>
pub fn description(&self) -> ::std::option::Option<&str> {
self.description.as_deref()
}
/// <p>The Amazon Resource Name (ARN) of the IAM role associated with the rule.</p>
pub fn role_arn(&self) -> ::std::option::Option<&str> {
self.role_arn.as_deref()
}
/// <p>If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.</p>
pub fn managed_by(&self) -> ::std::option::Option<&str> {
self.managed_by.as_deref()
}
/// <p>The name of the event bus associated with the rule.</p>
pub fn event_bus_name(&self) -> ::std::option::Option<&str> {
self.event_bus_name.as_deref()
}
/// <p>The account ID of the user that created the rule. If you use <code>PutRule</code> to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for <code>CreatedBy</code> is the account ID as the account that created the rule in the other account.</p>
pub fn created_by(&self) -> ::std::option::Option<&str> {
self.created_by.as_deref()
}
}
impl ::aws_http::request_id::RequestId for DescribeRuleOutput {
fn request_id(&self) -> Option<&str> {
self._request_id.as_deref()
}
}
impl DescribeRuleOutput {
/// Creates a new builder-style object to manufacture [`DescribeRuleOutput`](crate::operation::describe_rule::DescribeRuleOutput).
pub fn builder() -> crate::operation::describe_rule::builders::DescribeRuleOutputBuilder {
crate::operation::describe_rule::builders::DescribeRuleOutputBuilder::default()
}
}
/// A builder for [`DescribeRuleOutput`](crate::operation::describe_rule::DescribeRuleOutput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct DescribeRuleOutputBuilder {
pub(crate) name: ::std::option::Option<::std::string::String>,
pub(crate) arn: ::std::option::Option<::std::string::String>,
pub(crate) event_pattern: ::std::option::Option<::std::string::String>,
pub(crate) schedule_expression: ::std::option::Option<::std::string::String>,
pub(crate) state: ::std::option::Option<crate::types::RuleState>,
pub(crate) description: ::std::option::Option<::std::string::String>,
pub(crate) role_arn: ::std::option::Option<::std::string::String>,
pub(crate) managed_by: ::std::option::Option<::std::string::String>,
pub(crate) event_bus_name: ::std::option::Option<::std::string::String>,
pub(crate) created_by: ::std::option::Option<::std::string::String>,
_request_id: Option<String>,
}
impl DescribeRuleOutputBuilder {
/// <p>The name of the rule.</p>
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 rule.</p>
pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.name = input;
self
}
/// <p>The name of the rule.</p>
pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
&self.name
}
/// <p>The Amazon Resource Name (ARN) of the rule.</p>
pub fn arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the rule.</p>
pub fn set_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.arn = input;
self
}
/// <p>The Amazon Resource Name (ARN) of the rule.</p>
pub fn get_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.arn
}
/// <p>The event pattern. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html">Events and Event Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
pub fn event_pattern(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.event_pattern = ::std::option::Option::Some(input.into());
self
}
/// <p>The event pattern. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html">Events and Event Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
pub fn set_event_pattern(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.event_pattern = input;
self
}
/// <p>The event pattern. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html">Events and Event Patterns</a> in the <i>Amazon EventBridge User Guide</i>.</p>
pub fn get_event_pattern(&self) -> &::std::option::Option<::std::string::String> {
&self.event_pattern
}
/// <p>The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".</p>
pub fn schedule_expression(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.schedule_expression = ::std::option::Option::Some(input.into());
self
}
/// <p>The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".</p>
pub fn set_schedule_expression(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.schedule_expression = input;
self
}
/// <p>The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".</p>
pub fn get_schedule_expression(&self) -> &::std::option::Option<::std::string::String> {
&self.schedule_expression
}
/// <p>Specifies whether the rule is enabled or disabled.</p>
pub fn state(mut self, input: crate::types::RuleState) -> Self {
self.state = ::std::option::Option::Some(input);
self
}
/// <p>Specifies whether the rule is enabled or disabled.</p>
pub fn set_state(mut self, input: ::std::option::Option<crate::types::RuleState>) -> Self {
self.state = input;
self
}
/// <p>Specifies whether the rule is enabled or disabled.</p>
pub fn get_state(&self) -> &::std::option::Option<crate::types::RuleState> {
&self.state
}
/// <p>The description of the rule.</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>The description of the rule.</p>
pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.description = input;
self
}
/// <p>The description of the rule.</p>
pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
&self.description
}
/// <p>The Amazon Resource Name (ARN) of the IAM role associated with the rule.</p>
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 Amazon Resource Name (ARN) of the IAM role associated with the rule.</p>
pub fn set_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.role_arn = input;
self
}
/// <p>The Amazon Resource Name (ARN) of the IAM role associated with the rule.</p>
pub fn get_role_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.role_arn
}
/// <p>If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.</p>
pub fn managed_by(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.managed_by = ::std::option::Option::Some(input.into());
self
}
/// <p>If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.</p>
pub fn set_managed_by(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.managed_by = input;
self
}
/// <p>If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.</p>
pub fn get_managed_by(&self) -> &::std::option::Option<::std::string::String> {
&self.managed_by
}
/// <p>The name of the event bus associated with the rule.</p>
pub fn event_bus_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.event_bus_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the event bus associated with the rule.</p>
pub fn set_event_bus_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.event_bus_name = input;
self
}
/// <p>The name of the event bus associated with the rule.</p>
pub fn get_event_bus_name(&self) -> &::std::option::Option<::std::string::String> {
&self.event_bus_name
}
/// <p>The account ID of the user that created the rule. If you use <code>PutRule</code> to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for <code>CreatedBy</code> is the account ID as the account that created the rule in the other account.</p>
pub fn created_by(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.created_by = ::std::option::Option::Some(input.into());
self
}
/// <p>The account ID of the user that created the rule. If you use <code>PutRule</code> to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for <code>CreatedBy</code> is the account ID as the account that created the rule in the other account.</p>
pub fn set_created_by(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.created_by = input;
self
}
/// <p>The account ID of the user that created the rule. If you use <code>PutRule</code> to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for <code>CreatedBy</code> is the account ID as the account that created the rule in the other account.</p>
pub fn get_created_by(&self) -> &::std::option::Option<::std::string::String> {
&self.created_by
}
pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
self._request_id = Some(request_id.into());
self
}
pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
self._request_id = request_id;
self
}
/// Consumes the builder and constructs a [`DescribeRuleOutput`](crate::operation::describe_rule::DescribeRuleOutput).
pub fn build(self) -> crate::operation::describe_rule::DescribeRuleOutput {
crate::operation::describe_rule::DescribeRuleOutput {
name: self.name,
arn: self.arn,
event_pattern: self.event_pattern,
schedule_expression: self.schedule_expression,
state: self.state,
description: self.description,
role_arn: self.role_arn,
managed_by: self.managed_by,
event_bus_name: self.event_bus_name,
created_by: self.created_by,
_request_id: self._request_id,
}
}
}