@Generated(value="software.amazon.awssdk:codegen") public final class PutPermissionRequest extends EventBridgeRequest implements ToCopyableBuilder<PutPermissionRequest.Builder,PutPermissionRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
PutPermissionRequest.Builder |
| Modifier and Type | Method and 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 AWS organization.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
String |
eventBusName()
The name of the event bus associated with the rule.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
int |
hashCode() |
String |
policy()
A JSON string that describes the permission policy statement.
|
String |
principal()
The 12-digit AWS 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()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationcopypublic final String eventBusName()
The name of the event bus associated with the rule. If you omit this, the default event bus is used.
public final String action()
The action that you are enabling the other account to perform. Currently, this must be
events:PutEvents.
events:PutEvents.public final String principal()
The 12-digit AWS 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.
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.
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.
StatementId when you run
RemovePermission.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 AWS organization. For more information about AWS Organizations, see What Is AWS Organizations in the AWS Organizations User Guide.
If you specify Condition with an AWS 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.
If you specify Condition with an AWS 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.
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.
Policy
parameter in the request instead of using the StatementId, Action,
Principal, or Condition parameters.public PutPermissionRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<PutPermissionRequest.Builder,PutPermissionRequest>toBuilder in class EventBridgeRequestpublic static PutPermissionRequest.Builder builder()
public static Class<? extends PutPermissionRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo class,
and is generated based on a service model.
If an SdkPojo class does not have any inherited fields, equalsBySdkFields
and equals are essentially the same.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will
again be available.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.