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

Interface UpdateTrailRequest.Builder

    • Method Detail

      • name

        UpdateTrailRequest.Builder name​(String name)

        Specifies the name of the trail or trail ARN. If Name is a trail name, the string 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)

        If Name is a trail ARN, it must be in the following format.

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

        Parameters:
        name - Specifies the name of the trail or trail ARN. If Name is a trail name, the string 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)

        If Name is a trail ARN, it must be in the following format.

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

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

      • s3KeyPrefix

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

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

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

        UpdateTrailRequest.Builder isMultiRegionTrail​(Boolean isMultiRegionTrail)

        Specifies whether the trail applies only to the current Region or to all Regions. The default is false. If the trail exists only in the current Region and this value is set to true, shadow trails (replications of the trail) will be created in the other Regions. If the trail exists in all Regions and this value is set to false, the trail will remain in the Region where it was created, and its shadow trails in other Regions will be deleted. As a best practice, consider using trails that log events in all Regions.

        Parameters:
        isMultiRegionTrail - Specifies whether the trail applies only to the current Region or to all Regions. The default is false. If the trail exists only in the current Region and this value is set to true, shadow trails (replications of the trail) will be created in the other Regions. If the trail exists in all Regions and this value is set to false, the trail will remain in the Region where it was created, and its shadow trails in other Regions will be deleted. As a best practice, consider using trails that log events in all Regions.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enableLogFileValidation

        UpdateTrailRequest.Builder enableLogFileValidation​(Boolean enableLogFileValidation)

        Specifies whether log file 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 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

        UpdateTrailRequest.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 are 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 are 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

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

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

        UpdateTrailRequest.Builder isOrganizationTrail​(Boolean isOrganizationTrail)

        Specifies whether the trail is applied to 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 for an organization in Organizations. If the trail is not an organization trail and this is set to true, the trail will be created in all Amazon Web Services accounts that belong to the organization. If the trail is an organization trail and this is set to false, the trail will remain in the current Amazon Web Services account but be deleted from all member accounts in the organization.

        Only the management account for the organization can convert an organization trail to a non-organization trail, or convert a non-organization trail to an organization trail.

        Parameters:
        isOrganizationTrail - Specifies whether the trail is applied to 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 for an organization in Organizations. If the trail is not an organization trail and this is set to true, the trail will be created in all Amazon Web Services accounts that belong to the organization. If the trail is an organization trail and this is set to false, the trail will remain in the current Amazon Web Services account but be deleted from all member accounts in the organization.

        Only the management account for the organization can convert an organization trail to a non-organization trail, or convert a non-organization trail to an organization trail.

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