java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.eventbridge.model.EventBridgeRequest
    - - software.amazon.awssdk.services.eventbridge.model.PutPermissionRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<PutPermissionRequest.Builder,PutPermissionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class PutPermissionRequest
extends EventBridgeRequest
implements ToCopyableBuilder<PutPermissionRequest.Builder,PutPermissionRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface PutPermissionRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`action()`	The action that you are enabling the other account to perform.
`static PutPermissionRequest.Builder`	`builder()`
`Condition`	`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.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`eventBusName()`	The name of the event bus associated with the rule.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`policy()`	A JSON string that describes the permission policy statement.
`String`	`principal()`	The 12-digit Amazon Web Services account ID that you are permitting to put events to your default event bus.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PutPermissionRequest.Builder>`	`serializableBuilderClass()`
`String`	`statementId()`	An identifier string for the external account that you are granting permissions to.
`PutPermissionRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - eventBusName
```
public final String eventBusName()
```
    The name of the event bus associated with the rule. If you omit this, the default event bus is used.
    
    Returns:
    
    The name of the event bus associated with the rule. If you omit this, the default event bus is used.
  - action
```
public final String action()
```
    The action that you are enabling the other account to perform.
    
    Returns:
    
    The action that you are enabling the other account to perform.
  - principal
```
public final String 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 an account 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:
    
    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 an account 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.
  - statementId
```
public final String 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.
    
    Each StatementId must be unique.
    
    Returns:
    
    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.
    
    Each StatementId must be unique.
  - condition
```
public final Condition 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 for Principal, you grant permission to all the accounts in the named organization.
    
    The Condition is a JSON string which must contain Type, Key, and Value fields.
    
    Returns:
    
    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 for Principal, you grant permission to all the accounts in the named organization.
    
    The Condition is a JSON string which must contain Type, Key, and Value fields.
  - policy
```
public final String policy()
```
    A JSON string that describes the permission policy statement. You can include a Policy parameter in the request instead of using the StatementId, Action, Principal, or Condition parameters.
    
    Returns:
    
    A JSON string that describes the permission policy statement. You can include a Policy parameter in the request instead of using the StatementId, Action, Principal, or Condition parameters.
  - toBuilder
```
public PutPermissionRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PutPermissionRequest.Builder,PutPermissionRequest>
    
    Specified by:
    
    toBuilder in class EventBridgeRequest
  - builder
```
public static PutPermissionRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PutPermissionRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class PutPermissionRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

eventBusName

action

principal

statementId

condition

policy

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields