Interface PutPermissionRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CloudWatchEventsRequest.Builder
,CopyableBuilder<PutPermissionRequest.Builder,
,PutPermissionRequest> SdkBuilder<PutPermissionRequest.Builder,
,PutPermissionRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
PutPermissionRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe action that you are enabling the other account to perform.default PutPermissionRequest.Builder
condition
(Consumer<Condition.Builder> condition) 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.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.eventBusName
(String eventBusName) The name of the event bus associated with the rule.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.A JSON string that describes the permission policy statement.The 12-digit Amazon Web Services account ID that you are permitting to put events to your default event bus.statementId
(String statementId) An identifier string for the external account that you are granting permissions to.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.cloudwatchevents.model.CloudWatchEventsRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
eventBusName
The name of the event bus associated with the rule. If you omit this, the default event bus is used.
- Parameters:
eventBusName
- The name of the event bus associated with the rule. If you omit this, the default event bus is used.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
action
The action that you are enabling the other account to perform.
- Parameters:
action
- The action that you are enabling the other account to perform.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
principal
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.
If you specify "*" without specifying
Condition
, avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains anaccount
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.- Parameters:
principal
- 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.If you specify "*" without specifying
Condition
, avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains anaccount
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
statementId
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
StatementId
when you run RemovePermission.- Parameters:
statementId
- 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 thisStatementId
when you run RemovePermission.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
condition
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 What Is Amazon Web Services Organizations in the Amazon Web Services Organizations User Guide.
If you specify
Condition
with an Amazon Web Services organization ID, and specify "*" as the value forPrincipal
, you grant permission to all the accounts in the named organization.The
Condition
is a JSON string which must containType
,Key
, andValue
fields.- Parameters:
condition
- 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 What Is Amazon Web Services Organizations in the Amazon Web Services Organizations User Guide.If you specify
Condition
with an Amazon Web Services organization ID, and specify "*" as the value forPrincipal
, you grant permission to all the accounts in the named organization.The
Condition
is a JSON string which must containType
,Key
, andValue
fields.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
condition
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 What Is Amazon Web Services Organizations in the Amazon Web Services Organizations User Guide.
If you specify
Condition
with an Amazon Web Services organization ID, and specify "*" as the value forPrincipal
, you grant permission to all the accounts in the named organization.The
This is a convenience method that creates an instance of theCondition
is a JSON string which must containType
,Key
, andValue
fields.Condition.Builder
avoiding the need to create one manually viaCondition.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocondition(Condition)
.- Parameters:
condition
- a consumer that will call methods onCondition.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
policy
A JSON string that describes the permission policy statement. You can include a
Policy
parameter in the request instead of using theStatementId
,Action
,Principal
, orCondition
parameters.- Parameters:
policy
- A JSON string that describes the permission policy statement. You can include aPolicy
parameter in the request instead of using theStatementId
,Action
,Principal
, orCondition
parameters.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
PutPermissionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
PutPermissionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-