Interface StartExportJobV2Request.Builder

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

  • Method Details

    • name

      StartExportJobV2Request.Builder name(String name)

      An optional, user-provided name for the export job that helps you identify it in ListExportJobsV2 results. The value can be 1–256 characters. Alphanumeric characters, spaces, and the following ASCII characters are permitted: . _ , : ( ) / + -.

      Parameters:
      name - An optional, user-provided name for the export job that helps you identify it in ListExportJobsV2 results. The value can be 1–256 characters. Alphanumeric characters, spaces, and the following ASCII characters are permitted: . _ , : ( ) / + -.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destination

      StartExportJobV2Request.Builder destination(ExportDestination destination)

      The destination that Security Hub writes the export to. You must specify exactly one destination type. Currently, the only supported type is Amazon S3.

      Parameters:
      destination - The destination that Security Hub writes the export to. You must specify exactly one destination type. Currently, the only supported type is Amazon S3.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destination

      default StartExportJobV2Request.Builder destination(Consumer<ExportDestination.Builder> destination)

      The destination that Security Hub writes the export to. You must specify exactly one destination type. Currently, the only supported type is Amazon S3.

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

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

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

    • outputConfiguration

      StartExportJobV2Request.Builder outputConfiguration(ExportOutput outputConfiguration)

      Specifies what data to export and how to format it. You must specify exactly one output type. Currently, the only supported type is Findings.

      Parameters:
      outputConfiguration - Specifies what data to export and how to format it. You must specify exactly one output type. Currently, the only supported type is Findings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputConfiguration

      default StartExportJobV2Request.Builder outputConfiguration(Consumer<ExportOutput.Builder> outputConfiguration)

      Specifies what data to export and how to format it. You must specify exactly one output type. Currently, the only supported type is Findings.

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

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

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

    • scopes

      StartExportJobV2Request.Builder scopes(ExportScopes scopes)

      Limits the export to findings from specific organizational units (OUs) or from the delegated administrator's organization. Only the delegated administrator account can use this parameter; other accounts that specify it receive an AccessDeniedException.

      This parameter is optional. If you omit it, the delegated administrator exports findings from all accounts across the entire organization, and other accounts export only their own findings.

      You can specify up to 10 entries in Scopes.AwsOrganizations. If you specify multiple entries, Security Hub combines them using OR logic.

      Parameters:
      scopes - Limits the export to findings from specific organizational units (OUs) or from the delegated administrator's organization. Only the delegated administrator account can use this parameter; other accounts that specify it receive an AccessDeniedException.

      This parameter is optional. If you omit it, the delegated administrator exports findings from all accounts across the entire organization, and other accounts export only their own findings.

      You can specify up to 10 entries in Scopes.AwsOrganizations. If you specify multiple entries, Security Hub combines them using OR logic.

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

    • scopes

      default StartExportJobV2Request.Builder scopes(Consumer<ExportScopes.Builder> scopes)

      Limits the export to findings from specific organizational units (OUs) or from the delegated administrator's organization. Only the delegated administrator account can use this parameter; other accounts that specify it receive an AccessDeniedException.

      This parameter is optional. If you omit it, the delegated administrator exports findings from all accounts across the entire organization, and other accounts export only their own findings.

      You can specify up to 10 entries in Scopes.AwsOrganizations. If you specify multiple entries, Security Hub combines them using OR logic.

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

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

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

    • clientToken

      StartExportJobV2Request.Builder clientToken(String clientToken)

      A unique identifier used to ensure idempotency.

      Parameters:
      clientToken - A unique identifier used to ensure idempotency.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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