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

Interface CreateTrailRequest.Builder

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

  • Method Details

    • name

      CreateTrailRequest.Builder name(String name)

      Specifies the name of the trail. The name must meet the following requirements:

      • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)

      • Start with a letter or number, and end with a letter or number

      • Be between 3 and 128 characters

      • Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are not valid.

      • Not be in IP address format (for example, 192.168.5.4)

      Parameters:
      name - Specifies the name of the trail. The name must meet the following requirements:

      • Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)

      • Start with a letter or number, and end with a letter or number

      • Be between 3 and 128 characters

      • Have no adjacent periods, underscores or dashes. Names like my-_namespace and my--namespace are not valid.

      • Not be in IP address format (for example, 192.168.5.4)

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

    • s3BucketName

      CreateTrailRequest.Builder s3BucketName(String s3BucketName)

      Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.

      Parameters:
      s3BucketName - Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • s3KeyPrefix

      CreateTrailRequest.Builder s3KeyPrefix(String s3KeyPrefix)

      Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.

      Parameters:
      s3KeyPrefix - Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • snsTopicName

      CreateTrailRequest.Builder snsTopicName(String snsTopicName)

      Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.

      Parameters:
      snsTopicName - Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • includeGlobalServiceEvents

      CreateTrailRequest.Builder includeGlobalServiceEvents(Boolean includeGlobalServiceEvents)

      Specifies whether the trail is publishing events from global services such as IAM to the log files.

      Parameters:
      includeGlobalServiceEvents - Specifies whether the trail is publishing events from global services such as IAM to the log files.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isMultiRegionTrail

      CreateTrailRequest.Builder isMultiRegionTrail(Boolean isMultiRegionTrail)

      Specifies whether the trail is created in the current Region or in all Regions. The default is false, which creates a trail only in the Region where you are signed in. As a best practice, consider creating trails that log events in all Regions.

      Parameters:
      isMultiRegionTrail - Specifies whether the trail is created in the current Region or in all Regions. The default is false, which creates a trail only in the Region where you are signed in. As a best practice, consider creating trails that log events in all Regions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enableLogFileValidation

      CreateTrailRequest.Builder enableLogFileValidation(Boolean enableLogFileValidation)

      Specifies whether log file integrity validation is enabled. The default is false.

      When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail does not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.

      Parameters:
      enableLogFileValidation - Specifies whether log file integrity validation is enabled. The default is false.

      When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail does not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.

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

    • cloudWatchLogsLogGroupArn

      CreateTrailRequest.Builder cloudWatchLogsLogGroupArn(String cloudWatchLogsLogGroupArn)

      Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. You must use a log group that exists in your account.

      Not required unless you specify CloudWatchLogsRoleArn.

      Only the management account can configure a CloudWatch Logs log group for an organization trail.

      Parameters:
      cloudWatchLogsLogGroupArn - Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. You must use a log group that exists in your account.

      Not required unless you specify CloudWatchLogsRoleArn.

      Only the management account can configure a CloudWatch Logs log group for an organization trail.

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

    • cloudWatchLogsRoleArn

      CreateTrailRequest.Builder cloudWatchLogsRoleArn(String cloudWatchLogsRoleArn)

      Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. You must use a role that exists in your account.

      Parameters:
      cloudWatchLogsRoleArn - Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. You must use a role that exists in your account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsKeyId

      CreateTrailRequest.Builder kmsKeyId(String kmsKeyId)

      Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by alias/, a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

      CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.

      Examples:

      • alias/MyAliasName

      • arn:aws:kms:us-east-2:123456789012:alias/MyAliasName

      • arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012

      • 12345678-1234-1234-1234-123456789012

      Parameters:
      kmsKeyId - Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by alias/, a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.

      CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the Key Management Service Developer Guide.

      Examples:

      • alias/MyAliasName

      • arn:aws:kms:us-east-2:123456789012:alias/MyAliasName

      • arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012

      • 12345678-1234-1234-1234-123456789012

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

    • isOrganizationTrail

      CreateTrailRequest.Builder isOrganizationTrail(Boolean isOrganizationTrail)

      Specifies whether the trail is created for all accounts in an organization in Organizations, or only for the current Amazon Web Services account. The default is false, and cannot be true unless the call is made on behalf of an Amazon Web Services account that is the management account or delegated administrator account for an organization in Organizations.

      Parameters:
      isOrganizationTrail - Specifies whether the trail is created for all accounts in an organization in Organizations, or only for the current Amazon Web Services account. The default is false, and cannot be true unless the call is made on behalf of an Amazon Web Services account that is the management account or delegated administrator account for an organization in Organizations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagsList

      CreateTrailRequest.Builder tagsList(Collection<Tag> tagsList)
      Sets the value of the TagsList property for this object.
      Parameters:
      tagsList - The new value for the TagsList property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagsList

      CreateTrailRequest.Builder tagsList(Tag... tagsList)
      Sets the value of the TagsList property for this object.
      Parameters:
      tagsList - The new value for the TagsList property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagsList

      CreateTrailRequest.Builder tagsList(Consumer<Tag.Builder>... tagsList)
      Sets the value of the TagsList property for this object. This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

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

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

    • overrideConfiguration

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

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