Package software.amazon.awssdk.services.cloudtrail.model

Interface DescribeTrailsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CloudTrailRequest.Builder, CopyableBuilder<DescribeTrailsRequest.Builder,DescribeTrailsRequest>, SdkBuilder<DescribeTrailsRequest.Builder,DescribeTrailsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
DescribeTrailsRequest
public static interface DescribeTrailsRequest.Builder extends CloudTrailRequest.Builder, SdkPojo, CopyableBuilder<DescribeTrailsRequest.Builder,DescribeTrailsRequest>

  • Method Details

    • trailNameList

      DescribeTrailsRequest.Builder trailNameList(Collection<String> trailNameList)

      Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is:

      arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

      If an empty list is specified, information for the trail in the current Region is returned.

      • If an empty list is specified and IncludeShadowTrails is false, then information for all trails in the current Region is returned.

      • If an empty list is specified and IncludeShadowTrails is null or true, then information for all trails in the current Region and any associated shadow trails in other Regions is returned.

      If one or more trail names are specified, information is returned only if the names match the names of trails belonging only to the current Region and current account. To return information about a trail in another Region, you must specify its trail ARN.

      Parameters:
      trailNameList - Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is:

      arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

      If an empty list is specified, information for the trail in the current Region is returned.

      • If an empty list is specified and IncludeShadowTrails is false, then information for all trails in the current Region is returned.

      • If an empty list is specified and IncludeShadowTrails is null or true, then information for all trails in the current Region and any associated shadow trails in other Regions is returned.

      If one or more trail names are specified, information is returned only if the names match the names of trails belonging only to the current Region and current account. To return information about a trail in another Region, you must specify its trail ARN.

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

    • trailNameList

      DescribeTrailsRequest.Builder trailNameList(String... trailNameList)

      Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is:

      arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

      If an empty list is specified, information for the trail in the current Region is returned.

      • If an empty list is specified and IncludeShadowTrails is false, then information for all trails in the current Region is returned.

      • If an empty list is specified and IncludeShadowTrails is null or true, then information for all trails in the current Region and any associated shadow trails in other Regions is returned.

      If one or more trail names are specified, information is returned only if the names match the names of trails belonging only to the current Region and current account. To return information about a trail in another Region, you must specify its trail ARN.

      Parameters:
      trailNameList - Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is:

      arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

      If an empty list is specified, information for the trail in the current Region is returned.

      • If an empty list is specified and IncludeShadowTrails is false, then information for all trails in the current Region is returned.

      • If an empty list is specified and IncludeShadowTrails is null or true, then information for all trails in the current Region and any associated shadow trails in other Regions is returned.

      If one or more trail names are specified, information is returned only if the names match the names of trails belonging only to the current Region and current account. To return information about a trail in another Region, you must specify its trail ARN.

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

    • includeShadowTrails

      DescribeTrailsRequest.Builder includeShadowTrails(Boolean includeShadowTrails)

      Specifies whether to include shadow trails in the response. A shadow trail is the replication in a Region of a trail that was created in a different Region, or in the case of an organization trail, the replication of an organization trail in member accounts. If you do not include shadow trails, organization trails in a member account and Region replication trails will not be returned. The default is true.

      Parameters:
      includeShadowTrails - Specifies whether to include shadow trails in the response. A shadow trail is the replication in a Region of a trail that was created in a different Region, or in the case of an organization trail, the replication of an organization trail in member accounts. If you do not include shadow trails, organization trails in a member account and Region replication trails will not be returned. The default is true.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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