Package software.amazon.awssdk.services.ram.model

Interface CreatePermissionVersionRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreatePermissionVersionRequest.Builder,CreatePermissionVersionRequest>, RamRequest.Builder, SdkBuilder<CreatePermissionVersionRequest.Builder,CreatePermissionVersionRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreatePermissionVersionRequest
public static interface CreatePermissionVersionRequest.Builder extends RamRequest.Builder, SdkPojo, CopyableBuilder<CreatePermissionVersionRequest.Builder,CreatePermissionVersionRequest>

  • Method Details

    • permissionArn

      CreatePermissionVersionRequest.Builder permissionArn(String permissionArn)

      Specifies the Amazon Resource Name (ARN) of the customer managed permission you're creating a new version for.

      Parameters:
      permissionArn - Specifies the Amazon Resource Name (ARN) of the customer managed permission you're creating a new version for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • policyTemplate

      CreatePermissionVersionRequest.Builder policyTemplate(String policyTemplate)

      A string in JSON format string that contains the following elements of a resource-based policy:

      • Effect: must be set to ALLOW.

      • Action: specifies the actions that are allowed by this customer managed permission. The list must contain only actions that are supported by the specified resource type. For a list of all actions supported by each resource type, see Actions, resources, and condition keys for Amazon Web Services services in the Identity and Access Management User Guide.

      • Condition: (optional) specifies conditional parameters that must evaluate to true when a user attempts an action for that action to be allowed. For more information about the Condition element, see IAM policies: Condition element in the Identity and Access Management User Guide.

      This template can't include either the Resource or Principal elements. Those are both filled in by RAM when it instantiates the resource-based policy on each resource shared using this managed permission. The Resource comes from the ARN of the specific resource that you are sharing. The Principal comes from the list of identities added to the resource share.

      Parameters:
      policyTemplate - A string in JSON format string that contains the following elements of a resource-based policy:

      • Effect: must be set to ALLOW.

      • Action: specifies the actions that are allowed by this customer managed permission. The list must contain only actions that are supported by the specified resource type. For a list of all actions supported by each resource type, see Actions, resources, and condition keys for Amazon Web Services services in the Identity and Access Management User Guide.

      • Condition: (optional) specifies conditional parameters that must evaluate to true when a user attempts an action for that action to be allowed. For more information about the Condition element, see IAM policies: Condition element in the Identity and Access Management User Guide.

      This template can't include either the Resource or Principal elements. Those are both filled in by RAM when it instantiates the resource-based policy on each resource shared using this managed permission. The Resource comes from the ARN of the specific resource that you are sharing. The Principal comes from the list of identities added to the resource share.

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

    • clientToken

      CreatePermissionVersionRequest.Builder clientToken(String clientToken)

      Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

      If you don't provide this value, then Amazon Web Services generates a random one for you.

      If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

      Parameters:
      clientToken - Specifies a unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

      If you don't provide this value, then Amazon Web Services generates a random one for you.

      If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an IdempotentParameterMismatch error.

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

    • overrideConfiguration

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

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