Class DeleteResourcePolicyRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ssm.model.SsmRequest
software.amazon.awssdk.services.ssm.model.DeleteResourcePolicyRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DeleteResourcePolicyRequest.Builder,DeleteResourcePolicyRequest>
@Generated("software.amazon.awssdk:codegen") public final class DeleteResourcePolicyRequest extends SsmRequest implements ToCopyableBuilder<DeleteResourcePolicyRequest.Builder,DeleteResourcePolicyRequest>

  • Method Details

    • resourceArn

      public final String resourceArn()

      Amazon Resource Name (ARN) of the resource to which the policies are attached.

      Returns:
      Amazon Resource Name (ARN) of the resource to which the policies are attached.

    • policyId

      public final String policyId()

      The policy ID.

      Returns:
      The policy ID.

    • policyHash

      public final String policyHash()

      ID of the current policy version. The hash helps to prevent multiple calls from attempting to overwrite a policy.

      Returns:
      ID of the current policy version. The hash helps to prevent multiple calls from attempting to overwrite a policy.

    • deletionMode

      public final DeletionMode deletionMode()

      Specifies the intended outcome of the operation. Applies only to the Document resource type. The operation ignores this parameter for other resource types. Optional. Defaults to RemoveSharing.

      • RemoveSharing – Deletes the resource policy and removes sharing of the document.

      • RollbackMigration – Reverts the document to Custom sharing, preserving existing consumer access, instead of removing the policy.

      If the service returns an enum value that is not available in the current SDK version, deletionMode will return DeletionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deletionModeAsString().

      Returns:
      Specifies the intended outcome of the operation. Applies only to the Document resource type. The operation ignores this parameter for other resource types. Optional. Defaults to RemoveSharing.

      • RemoveSharing – Deletes the resource policy and removes sharing of the document.

      • RollbackMigration – Reverts the document to Custom sharing, preserving existing consumer access, instead of removing the policy.

      See Also:

    • deletionModeAsString

      public final String deletionModeAsString()

      Specifies the intended outcome of the operation. Applies only to the Document resource type. The operation ignores this parameter for other resource types. Optional. Defaults to RemoveSharing.

      • RemoveSharing – Deletes the resource policy and removes sharing of the document.

      • RollbackMigration – Reverts the document to Custom sharing, preserving existing consumer access, instead of removing the policy.

      If the service returns an enum value that is not available in the current SDK version, deletionMode will return DeletionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deletionModeAsString().

      Returns:
      Specifies the intended outcome of the operation. Applies only to the Document resource type. The operation ignores this parameter for other resource types. Optional. Defaults to RemoveSharing.

      • RemoveSharing – Deletes the resource policy and removes sharing of the document.

      • RollbackMigration – Reverts the document to Custom sharing, preserving existing consumer access, instead of removing the policy.

      See Also:

    • toBuilder

      public DeleteResourcePolicyRequest.Builder 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 interface ToCopyableBuilder<DeleteResourcePolicyRequest.Builder,DeleteResourcePolicyRequest>
      Specified by:
      toBuilder in class SsmRequest
      Returns:
      a builder for type T

    • builder

      public static DeleteResourcePolicyRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DeleteResourcePolicyRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.