Interface StartPolicyPreviewJobRequest.Builder

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

  • Method Details

    • policyConfigurations

      StartPolicyPreviewJobRequest.Builder policyConfigurations(Collection<PolicyConfiguration> policyConfigurations)

      A list of policy configurations to analyze. Currently limited to one configuration per request. Each configuration specifies the job type, target ID, and policy documents to test.

      Parameters:
      policyConfigurations - A list of policy configurations to analyze. Currently limited to one configuration per request. Each configuration specifies the job type, target ID, and policy documents to test.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • policyConfigurations

      StartPolicyPreviewJobRequest.Builder policyConfigurations(PolicyConfiguration... policyConfigurations)

      A list of policy configurations to analyze. Currently limited to one configuration per request. Each configuration specifies the job type, target ID, and policy documents to test.

      Parameters:
      policyConfigurations - A list of policy configurations to analyze. Currently limited to one configuration per request. Each configuration specifies the job type, target ID, and policy documents to test.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • policyConfigurations

      StartPolicyPreviewJobRequest.Builder policyConfigurations(Consumer<PolicyConfiguration.Builder>... policyConfigurations)

      A list of policy configurations to analyze. Currently limited to one configuration per request. Each configuration specifies the job type, target ID, and policy documents to test.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to policyConfigurations(List<PolicyConfiguration>).

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

    • startTime

      StartPolicyPreviewJobRequest.Builder startTime(Instant startTime)

      The start of the CloudTrail event analysis window. The analysis will evaluate events from this time forward.

      Parameters:
      startTime - The start of the CloudTrail event analysis window. The analysis will evaluate events from this time forward.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endTime

      StartPolicyPreviewJobRequest.Builder endTime(Instant endTime)

      The end of the analysis window. If not specified, defaults to the time of the request. The analysis will evaluate CloudTrail events up to this time.

      Parameters:
      endTime - The end of the analysis window. If not specified, defaults to the time of the request. The analysis will evaluate CloudTrail events up to this time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputS3Uri

      StartPolicyPreviewJobRequest.Builder outputS3Uri(String outputS3Uri)

      The Amazon S3 URI where the completed analysis report will be stored. The Amazon S3 bucket must grant access to the IAM Access Analyzer service principal in its resource policy. The report will be stored at the path: outputS3Uri/jobId/timestamp/.

      Parameters:
      outputS3Uri - The Amazon S3 URI where the completed analysis report will be stored. The Amazon S3 bucket must grant access to the IAM Access Analyzer service principal in its resource policy. The report will be stored at the path: outputS3Uri/jobId/timestamp/.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      StartPolicyPreviewJobRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request and have no additional effect.

      Parameters:
      clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request and have no additional effect.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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