Class PutPermissionRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<PutPermissionRequest.Builder,
PutPermissionRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
action()
The action that you are enabling the other account to perform.static PutPermissionRequest.Builder
builder()
final 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.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The name of the event bus associated with the rule.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
policy()
A JSON string that describes the permission policy statement.final String
The 12-digit Amazon Web Services account ID that you are permitting to put events to your default event bus.static Class
<? extends PutPermissionRequest.Builder> final String
An identifier string for the external account that you are granting permissions to.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The action that you are enabling the other account to perform.
- Returns:
- The action that you are enabling the other account to perform.
-
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:
- 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.
-
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.- 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.
-
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:
- 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.
-
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.- Returns:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<PutPermissionRequest.Builder,
PutPermissionRequest> - Specified by:
toBuilder
in classCloudWatchEventsRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-