Interface UpdatePolicyRequest.Builder

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

  • Method Details

    • policyStoreId

      UpdatePolicyRequest.Builder policyStoreId(String policyStoreId)

      Specifies the ID of the policy store that contains the policy that you want to update.

      To specify a policy store, use its ID or alias name. When using an alias name, prefix it with policy-store-alias/. For example:

      • ID: PSEXAMPLEabcdefg111111

      • Alias name: policy-store-alias/example-policy-store

      To view aliases, use ListPolicyStoreAliases.

      Parameters:
      policyStoreId - Specifies the ID of the policy store that contains the policy that you want to update.

      To specify a policy store, use its ID or alias name. When using an alias name, prefix it with policy-store-alias/. For example:

      • ID: PSEXAMPLEabcdefg111111

      • Alias name: policy-store-alias/example-policy-store

      To view aliases, use ListPolicyStoreAliases.

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

    • policyId

      UpdatePolicyRequest.Builder policyId(String policyId)

      Specifies the ID of the policy that you want to update. To find this value, you can use ListPolicies.

      You can use the policy name in place of the policy ID. When using a name, prefix it with name/. For example:

      • ID: SPEXAMPLEabcdefg111111

      • Name: name/example-policy

      Parameters:
      policyId - Specifies the ID of the policy that you want to update. To find this value, you can use ListPolicies.

      You can use the policy name in place of the policy ID. When using a name, prefix it with name/. For example:

      • ID: SPEXAMPLEabcdefg111111

      • Name: name/example-policy

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

    • definition

      UpdatePolicyRequest.Builder definition(UpdatePolicyDefinition definition)

      Specifies the updated policy content that you want to replace on the specified policy. The content must be valid Cedar policy language text.

      If you don't specify this parameter, the existing policy definition remains unchanged.

      You can change only the following elements from the policy definition:

      • The action referenced by the policy.

      • Any conditional clauses, such as when or unless clauses.

      You can't change the following elements:

      • Changing from static to templateLinked.

      • Changing the effect of the policy from permit or forbid.

      • The principal referenced by the policy.

      • The resource referenced by the policy.

      Parameters:
      definition - Specifies the updated policy content that you want to replace on the specified policy. The content must be valid Cedar policy language text.

      If you don't specify this parameter, the existing policy definition remains unchanged.

      You can change only the following elements from the policy definition:

      • The action referenced by the policy.

      • Any conditional clauses, such as when or unless clauses.

      You can't change the following elements:

      • Changing from static to templateLinked.

      • Changing the effect of the policy from permit or forbid.

      • The principal referenced by the policy.

      • The resource referenced by the policy.

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

    • definition

      default UpdatePolicyRequest.Builder definition(Consumer<UpdatePolicyDefinition.Builder> definition)

      Specifies the updated policy content that you want to replace on the specified policy. The content must be valid Cedar policy language text.

      If you don't specify this parameter, the existing policy definition remains unchanged.

      You can change only the following elements from the policy definition:

      • The action referenced by the policy.

      • Any conditional clauses, such as when or unless clauses.

      You can't change the following elements:

      • Changing from static to templateLinked.

      • Changing the effect of the policy from permit or forbid.

      • The principal referenced by the policy.

      • The resource referenced by the policy.

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

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

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

    • name

      UpdatePolicyRequest.Builder name(String name)

      Specifies a name for the policy that is unique among all policies within the policy store. You can use the name in place of the policy ID in API operations that reference the policy. The name must be prefixed with name/.

      If you don't include the name in an update request, the existing name is unchanged. To remove a name, set it to an empty string ("").

      If you specify a name that is already associated with another policy in the policy store, you receive a ConflictException error.

      Parameters:
      name - Specifies a name for the policy that is unique among all policies within the policy store. You can use the name in place of the policy ID in API operations that reference the policy. The name must be prefixed with name/.

      If you don't include the name in an update request, the existing name is unchanged. To remove a name, set it to an empty string ("").

      If you specify a name that is already associated with another policy in the policy store, you receive a ConflictException error.

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

    • overrideConfiguration

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

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