Package software.amazon.awssdk.services.eventbridge.model

Interface PutPermissionRequest.Builder

    • Method Detail

      • eventBusName

        PutPermissionRequest.Builder eventBusName​(String 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

        PutPermissionRequest.Builder action​(String 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

        PutPermissionRequest.Builder principal​(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.

        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 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:
        Returns a reference to this object so that method calls can be chained together.

      • statementId

        PutPermissionRequest.Builder statementId​(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.

        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 this StatementId when you run RemovePermission.

        Each StatementId must be unique.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • condition

        PutPermissionRequest.Builder condition​(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.

        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 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:
        Returns a reference to this object so that method calls can be chained together.

      • condition

        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. 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.

        This is a convenience method that creates an instance of the Condition.Builder avoiding the need to create one manually via Condition.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to condition(Condition).

        Parameters:
        condition - a consumer that will call methods on Condition.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        condition(Condition)

      • policy

        PutPermissionRequest.Builder policy​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.