Class ValidatePolicyRequest

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

  • Method Details

    • locale

      public final Locale locale()

      The locale to use for localizing the findings.

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

      Returns:
      The locale to use for localizing the findings.
      See Also:

    • localeAsString

      public final String localeAsString()

      The locale to use for localizing the findings.

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

      Returns:
      The locale to use for localizing the findings.
      See Also:

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return in the response.

      Returns:
      The maximum number of results to return in the response.

    • nextToken

      public final String nextToken()

      A token used for pagination of results returned.

      Returns:
      A token used for pagination of results returned.

    • policyDocument

      public final String policyDocument()

      The JSON policy document to use as the content for the policy.

      Returns:
      The JSON policy document to use as the content for the policy.

    • policyType

      public final PolicyType policyType()

      The type of policy to validate. Identity policies grant permissions to IAM principals. Identity policies include managed and inline policies for IAM roles, users, and groups.

      Resource policies grant permissions on Amazon Web Services resources. Resource policies include trust policies for IAM roles and bucket policies for Amazon S3 buckets. You can provide a generic input such as identity policy or resource policy or a specific input such as managed policy or Amazon S3 bucket policy.

      Service control policies (SCPs) are a type of organization policy attached to an Amazon Web Services organization, organizational unit (OU), or an account.

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

      Returns:
      The type of policy to validate. Identity policies grant permissions to IAM principals. Identity policies include managed and inline policies for IAM roles, users, and groups.

      Resource policies grant permissions on Amazon Web Services resources. Resource policies include trust policies for IAM roles and bucket policies for Amazon S3 buckets. You can provide a generic input such as identity policy or resource policy or a specific input such as managed policy or Amazon S3 bucket policy.

      Service control policies (SCPs) are a type of organization policy attached to an Amazon Web Services organization, organizational unit (OU), or an account.

      See Also:

    • policyTypeAsString

      public final String policyTypeAsString()

      The type of policy to validate. Identity policies grant permissions to IAM principals. Identity policies include managed and inline policies for IAM roles, users, and groups.

      Resource policies grant permissions on Amazon Web Services resources. Resource policies include trust policies for IAM roles and bucket policies for Amazon S3 buckets. You can provide a generic input such as identity policy or resource policy or a specific input such as managed policy or Amazon S3 bucket policy.

      Service control policies (SCPs) are a type of organization policy attached to an Amazon Web Services organization, organizational unit (OU), or an account.

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

      Returns:
      The type of policy to validate. Identity policies grant permissions to IAM principals. Identity policies include managed and inline policies for IAM roles, users, and groups.

      Resource policies grant permissions on Amazon Web Services resources. Resource policies include trust policies for IAM roles and bucket policies for Amazon S3 buckets. You can provide a generic input such as identity policy or resource policy or a specific input such as managed policy or Amazon S3 bucket policy.

      Service control policies (SCPs) are a type of organization policy attached to an Amazon Web Services organization, organizational unit (OU), or an account.

      See Also:

    • validatePolicyResourceType

      public final ValidatePolicyResourceType validatePolicyResourceType()

      The type of resource to attach to your resource policy. Specify a value for the policy validation resource type only if the policy type is RESOURCE_POLICY. For example, to validate a resource policy to attach to an Amazon S3 bucket, you can choose AWS::S3::Bucket for the policy validation resource type.

      For resource types not supported as valid values, IAM Access Analyzer runs policy checks that apply to all resource policies. For example, to validate a resource policy to attach to a KMS key, do not specify a value for the policy validation resource type and IAM Access Analyzer will run policy checks that apply to all resource policies.

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

      Returns:
      The type of resource to attach to your resource policy. Specify a value for the policy validation resource type only if the policy type is RESOURCE_POLICY. For example, to validate a resource policy to attach to an Amazon S3 bucket, you can choose AWS::S3::Bucket for the policy validation resource type.

      For resource types not supported as valid values, IAM Access Analyzer runs policy checks that apply to all resource policies. For example, to validate a resource policy to attach to a KMS key, do not specify a value for the policy validation resource type and IAM Access Analyzer will run policy checks that apply to all resource policies.

      See Also:

    • validatePolicyResourceTypeAsString

      public final String validatePolicyResourceTypeAsString()

      The type of resource to attach to your resource policy. Specify a value for the policy validation resource type only if the policy type is RESOURCE_POLICY. For example, to validate a resource policy to attach to an Amazon S3 bucket, you can choose AWS::S3::Bucket for the policy validation resource type.

      For resource types not supported as valid values, IAM Access Analyzer runs policy checks that apply to all resource policies. For example, to validate a resource policy to attach to a KMS key, do not specify a value for the policy validation resource type and IAM Access Analyzer will run policy checks that apply to all resource policies.

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

      Returns:
      The type of resource to attach to your resource policy. Specify a value for the policy validation resource type only if the policy type is RESOURCE_POLICY. For example, to validate a resource policy to attach to an Amazon S3 bucket, you can choose AWS::S3::Bucket for the policy validation resource type.

      For resource types not supported as valid values, IAM Access Analyzer runs policy checks that apply to all resource policies. For example, to validate a resource policy to attach to a KMS key, do not specify a value for the policy validation resource type and IAM Access Analyzer will run policy checks that apply to all resource policies.

      See Also:

    • toBuilder

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

    • builder

      public static ValidatePolicyRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ValidatePolicyRequest.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.