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
// 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 PutPermissionInput {
/// <p>The name of the event bus associated with the rule. If you omit this, the default event bus is used.</p>
pub event_bus_name: ::std::option::Option<::std::string::String>,
/// <p>The action that you are enabling the other account to perform.</p>
pub action: ::std::option::Option<::std::string::String>,
/// <p>The 12-digit Amazon Web Services account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus.</p>
/// <p>If you specify "*" without specifying <code>Condition</code>, avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an <code>account</code> field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.</p>
pub principal: ::std::option::Option<::std::string::String>,
/// <p>An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this <code>StatementId</code> when you run <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html">RemovePermission</a>.</p> <note>
/// <p>Each <code>StatementId</code> must be unique.</p>
/// </note>
pub statement_id: ::std::option::Option<::std::string::String>,
/// <p>This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain Amazon Web Services organization. For more information about Amazon Web Services Organizations, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html">What Is Amazon Web Services Organizations</a> in the <i>Amazon Web Services Organizations User Guide</i>.</p>
/// <p>If you specify <code>Condition</code> with an Amazon Web Services organization ID, and specify "*" as the value for <code>Principal</code>, you grant permission to all the accounts in the named organization.</p>
/// <p>The <code>Condition</code> is a JSON string which must contain <code>Type</code>, <code>Key</code>, and <code>Value</code> fields.</p>
pub condition: ::std::option::Option<crate::types::Condition>,
/// <p>A JSON string that describes the permission policy statement. You can include a <code>Policy</code> parameter in the request instead of using the <code>StatementId</code>, <code>Action</code>, <code>Principal</code>, or <code>Condition</code> parameters.</p>
pub policy: ::std::option::Option<::std::string::String>,
}
impl PutPermissionInput {
/// <p>The name of the event bus associated with the rule. If you omit this, the default event bus is used.</p>
pub fn event_bus_name(&self) -> ::std::option::Option<&str> {
self.event_bus_name.as_deref()
}
/// <p>The action that you are enabling the other account to perform.</p>
pub fn action(&self) -> ::std::option::Option<&str> {
self.action.as_deref()
}
/// <p>The 12-digit Amazon Web Services account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus.</p>
/// <p>If you specify "*" without specifying <code>Condition</code>, avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an <code>account</code> field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.</p>
pub fn principal(&self) -> ::std::option::Option<&str> {
self.principal.as_deref()
}
/// <p>An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this <code>StatementId</code> when you run <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html">RemovePermission</a>.</p> <note>
/// <p>Each <code>StatementId</code> must be unique.</p>
/// </note>
pub fn statement_id(&self) -> ::std::option::Option<&str> {
self.statement_id.as_deref()
}
/// <p>This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain Amazon Web Services organization. For more information about Amazon Web Services Organizations, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html">What Is Amazon Web Services Organizations</a> in the <i>Amazon Web Services Organizations User Guide</i>.</p>
/// <p>If you specify <code>Condition</code> with an Amazon Web Services organization ID, and specify "*" as the value for <code>Principal</code>, you grant permission to all the accounts in the named organization.</p>
/// <p>The <code>Condition</code> is a JSON string which must contain <code>Type</code>, <code>Key</code>, and <code>Value</code> fields.</p>
pub fn condition(&self) -> ::std::option::Option<&crate::types::Condition> {
self.condition.as_ref()
}
/// <p>A JSON string that describes the permission policy statement. You can include a <code>Policy</code> parameter in the request instead of using the <code>StatementId</code>, <code>Action</code>, <code>Principal</code>, or <code>Condition</code> parameters.</p>
pub fn policy(&self) -> ::std::option::Option<&str> {
self.policy.as_deref()
}
}
impl PutPermissionInput {
/// Creates a new builder-style object to manufacture [`PutPermissionInput`](crate::operation::put_permission::PutPermissionInput).
pub fn builder() -> crate::operation::put_permission::builders::PutPermissionInputBuilder {
crate::operation::put_permission::builders::PutPermissionInputBuilder::default()
}
}
/// A builder for [`PutPermissionInput`](crate::operation::put_permission::PutPermissionInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct PutPermissionInputBuilder {
pub(crate) event_bus_name: ::std::option::Option<::std::string::String>,
pub(crate) action: ::std::option::Option<::std::string::String>,
pub(crate) principal: ::std::option::Option<::std::string::String>,
pub(crate) statement_id: ::std::option::Option<::std::string::String>,
pub(crate) condition: ::std::option::Option<crate::types::Condition>,
pub(crate) policy: ::std::option::Option<::std::string::String>,
}
impl PutPermissionInputBuilder {
/// <p>The name of the event bus associated with the rule. If you omit this, the default event bus is used.</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. If you omit this, the default event bus is used.</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. If you omit this, the default event bus is used.</p>
pub fn get_event_bus_name(&self) -> &::std::option::Option<::std::string::String> {
&self.event_bus_name
}
/// <p>The action that you are enabling the other account to perform.</p>
pub fn action(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.action = ::std::option::Option::Some(input.into());
self
}
/// <p>The action that you are enabling the other account to perform.</p>
pub fn set_action(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.action = input;
self
}
/// <p>The action that you are enabling the other account to perform.</p>
pub fn get_action(&self) -> &::std::option::Option<::std::string::String> {
&self.action
}
/// <p>The 12-digit Amazon Web Services account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus.</p>
/// <p>If you specify "*" without specifying <code>Condition</code>, avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an <code>account</code> field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.</p>
pub fn principal(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.principal = ::std::option::Option::Some(input.into());
self
}
/// <p>The 12-digit Amazon Web Services account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus.</p>
/// <p>If you specify "*" without specifying <code>Condition</code>, avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an <code>account</code> field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.</p>
pub fn set_principal(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.principal = input;
self
}
/// <p>The 12-digit Amazon Web Services account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus.</p>
/// <p>If you specify "*" without specifying <code>Condition</code>, avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an <code>account</code> field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.</p>
pub fn get_principal(&self) -> &::std::option::Option<::std::string::String> {
&self.principal
}
/// <p>An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this <code>StatementId</code> when you run <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html">RemovePermission</a>.</p> <note>
/// <p>Each <code>StatementId</code> must be unique.</p>
/// </note>
pub fn statement_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.statement_id = ::std::option::Option::Some(input.into());
self
}
/// <p>An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this <code>StatementId</code> when you run <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html">RemovePermission</a>.</p> <note>
/// <p>Each <code>StatementId</code> must be unique.</p>
/// </note>
pub fn set_statement_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.statement_id = input;
self
}
/// <p>An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this <code>StatementId</code> when you run <a href="https://docs.aws.amazon.com/eventbridge/latest/APIReference/API_RemovePermission.html">RemovePermission</a>.</p> <note>
/// <p>Each <code>StatementId</code> must be unique.</p>
/// </note>
pub fn get_statement_id(&self) -> &::std::option::Option<::std::string::String> {
&self.statement_id
}
/// <p>This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain Amazon Web Services organization. For more information about Amazon Web Services Organizations, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html">What Is Amazon Web Services Organizations</a> in the <i>Amazon Web Services Organizations User Guide</i>.</p>
/// <p>If you specify <code>Condition</code> with an Amazon Web Services organization ID, and specify "*" as the value for <code>Principal</code>, you grant permission to all the accounts in the named organization.</p>
/// <p>The <code>Condition</code> is a JSON string which must contain <code>Type</code>, <code>Key</code>, and <code>Value</code> fields.</p>
pub fn condition(mut self, input: crate::types::Condition) -> Self {
self.condition = ::std::option::Option::Some(input);
self
}
/// <p>This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain Amazon Web Services organization. For more information about Amazon Web Services Organizations, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html">What Is Amazon Web Services Organizations</a> in the <i>Amazon Web Services Organizations User Guide</i>.</p>
/// <p>If you specify <code>Condition</code> with an Amazon Web Services organization ID, and specify "*" as the value for <code>Principal</code>, you grant permission to all the accounts in the named organization.</p>
/// <p>The <code>Condition</code> is a JSON string which must contain <code>Type</code>, <code>Key</code>, and <code>Value</code> fields.</p>
pub fn set_condition(mut self, input: ::std::option::Option<crate::types::Condition>) -> Self {
self.condition = input;
self
}
/// <p>This parameter enables you to limit the permission to accounts that fulfill a certain condition, such as being a member of a certain Amazon Web Services organization. For more information about Amazon Web Services Organizations, see <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_introduction.html">What Is Amazon Web Services Organizations</a> in the <i>Amazon Web Services Organizations User Guide</i>.</p>
/// <p>If you specify <code>Condition</code> with an Amazon Web Services organization ID, and specify "*" as the value for <code>Principal</code>, you grant permission to all the accounts in the named organization.</p>
/// <p>The <code>Condition</code> is a JSON string which must contain <code>Type</code>, <code>Key</code>, and <code>Value</code> fields.</p>
pub fn get_condition(&self) -> &::std::option::Option<crate::types::Condition> {
&self.condition
}
/// <p>A JSON string that describes the permission policy statement. You can include a <code>Policy</code> parameter in the request instead of using the <code>StatementId</code>, <code>Action</code>, <code>Principal</code>, or <code>Condition</code> parameters.</p>
pub fn policy(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.policy = ::std::option::Option::Some(input.into());
self
}
/// <p>A JSON string that describes the permission policy statement. You can include a <code>Policy</code> parameter in the request instead of using the <code>StatementId</code>, <code>Action</code>, <code>Principal</code>, or <code>Condition</code> parameters.</p>
pub fn set_policy(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.policy = input;
self
}
/// <p>A JSON string that describes the permission policy statement. You can include a <code>Policy</code> parameter in the request instead of using the <code>StatementId</code>, <code>Action</code>, <code>Principal</code>, or <code>Condition</code> parameters.</p>
pub fn get_policy(&self) -> &::std::option::Option<::std::string::String> {
&self.policy
}
/// Consumes the builder and constructs a [`PutPermissionInput`](crate::operation::put_permission::PutPermissionInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::put_permission::PutPermissionInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::put_permission::PutPermissionInput {
event_bus_name: self.event_bus_name,
action: self.action,
principal: self.principal,
statement_id: self.statement_id,
condition: self.condition,
policy: self.policy,
})
}
}