Class GetGeneratedPolicyRequest

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.GetGeneratedPolicyRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetGeneratedPolicyRequest.Builder,GetGeneratedPolicyRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetGeneratedPolicyRequest extends AccessAnalyzerRequest implements ToCopyableBuilder<GetGeneratedPolicyRequest.Builder,GetGeneratedPolicyRequest>

  • Method Details

    • jobId

      public final String jobId()

      The JobId that is returned by the StartPolicyGeneration operation. The JobId can be used with GetGeneratedPolicy to retrieve the generated policies or used with CancelPolicyGeneration to cancel the policy generation request.

      Returns:
      The JobId that is returned by the StartPolicyGeneration operation. The JobId can be used with GetGeneratedPolicy to retrieve the generated policies or used with CancelPolicyGeneration to cancel the policy generation request.

    • includeResourcePlaceholders

      public final Boolean includeResourcePlaceholders()

      The level of detail that you want to generate. You can specify whether to generate policies with placeholders for resource ARNs for actions that support resource level granularity in policies.

      For example, in the resource section of a policy, you can receive a placeholder such as "Resource":"arn:aws:s3:::${BucketName}" instead of "*".

      Returns:
      The level of detail that you want to generate. You can specify whether to generate policies with placeholders for resource ARNs for actions that support resource level granularity in policies.

      For example, in the resource section of a policy, you can receive a placeholder such as "Resource":"arn:aws:s3:::${BucketName}" instead of "*".

    • includeServiceLevelTemplate

      public final Boolean includeServiceLevelTemplate()

      The level of detail that you want to generate. You can specify whether to generate service-level policies.

      IAM Access Analyzer uses iam:servicelastaccessed to identify services that have been used recently to create this service-level template.

      Returns:
      The level of detail that you want to generate. You can specify whether to generate service-level policies.

      IAM Access Analyzer uses iam:servicelastaccessed to identify services that have been used recently to create this service-level template.

    • toBuilder

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

    • builder

      public static GetGeneratedPolicyRequest.Builder builder()

    • serializableBuilderClass

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