Interface CreateGatewayRuleRequest.Builder

All Superinterfaces:
AwsRequest.Builder, BedrockAgentCoreControlRequest.Builder, Buildable, CopyableBuilder<CreateGatewayRuleRequest.Builder,CreateGatewayRuleRequest>, SdkBuilder<CreateGatewayRuleRequest.Builder,CreateGatewayRuleRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateGatewayRuleRequest
@Mutable @NotThreadSafe public static interface CreateGatewayRuleRequest.Builder extends BedrockAgentCoreControlRequest.Builder, SdkPojo, CopyableBuilder<CreateGatewayRuleRequest.Builder,CreateGatewayRuleRequest>

  • Method Details

    • gatewayIdentifier

      CreateGatewayRuleRequest.Builder gatewayIdentifier(String gatewayIdentifier)

      The identifier of the gateway to create a rule for.

      Parameters:
      gatewayIdentifier - The identifier of the gateway to create a rule for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      CreateGatewayRuleRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.

      Parameters:
      clientToken - A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • priority

      CreateGatewayRuleRequest.Builder priority(Integer priority)

      The priority of the rule. Rules are evaluated in order of priority, with lower numbers evaluated first. Must be between 1 and 1,000,000.

      Parameters:
      priority - The priority of the rule. Rules are evaluated in order of priority, with lower numbers evaluated first. Must be between 1 and 1,000,000.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • conditions

      CreateGatewayRuleRequest.Builder conditions(Collection<Condition> conditions)

      The conditions that must be met for the rule to apply. Conditions can match on principals (IAM ARNs) or request paths.

      Parameters:
      conditions - The conditions that must be met for the rule to apply. Conditions can match on principals (IAM ARNs) or request paths.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • conditions

      CreateGatewayRuleRequest.Builder conditions(Condition... conditions)

      The conditions that must be met for the rule to apply. Conditions can match on principals (IAM ARNs) or request paths.

      Parameters:
      conditions - The conditions that must be met for the rule to apply. Conditions can match on principals (IAM ARNs) or request paths.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • conditions

      CreateGatewayRuleRequest.Builder conditions(Consumer<Condition.Builder>... conditions)

      The conditions that must be met for the rule to apply. Conditions can match on principals (IAM ARNs) or request paths.

      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 conditions(List<Condition>).

      Parameters:
      conditions - 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:

    • actions

      CreateGatewayRuleRequest.Builder actions(Collection<Action> actions)

      The actions to take when the rule conditions are met. Actions can route to a specific target or apply a configuration bundle override.

      Parameters:
      actions - The actions to take when the rule conditions are met. Actions can route to a specific target or apply a configuration bundle override.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • actions

      CreateGatewayRuleRequest.Builder actions(Action... actions)

      The actions to take when the rule conditions are met. Actions can route to a specific target or apply a configuration bundle override.

      Parameters:
      actions - The actions to take when the rule conditions are met. Actions can route to a specific target or apply a configuration bundle override.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • actions

      CreateGatewayRuleRequest.Builder actions(Consumer<Action.Builder>... actions)

      The actions to take when the rule conditions are met. Actions can route to a specific target or apply a configuration bundle override.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to actions(List<Action>).

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

    • description

      CreateGatewayRuleRequest.Builder description(String description)

      The description of the gateway rule.

      Parameters:
      description - The description of the gateway rule.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateGatewayRuleRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateGatewayRuleRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.