AWS SDK for C++  1.8.72
AWS SDK for C++
Public Member Functions | List of all members
Aws::CloudTrail::Model::UpdateTrailRequest Class Reference

#include <UpdateTrailRequest.h>

+ Inheritance diagram for Aws::CloudTrail::Model::UpdateTrailRequest:

Public Member Functions

 UpdateTrailRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
UpdateTrailRequestWithName (const Aws::String &value)
 
UpdateTrailRequestWithName (Aws::String &&value)
 
UpdateTrailRequestWithName (const char *value)
 
const Aws::StringGetS3BucketName () const
 
bool S3BucketNameHasBeenSet () const
 
void SetS3BucketName (const Aws::String &value)
 
void SetS3BucketName (Aws::String &&value)
 
void SetS3BucketName (const char *value)
 
UpdateTrailRequestWithS3BucketName (const Aws::String &value)
 
UpdateTrailRequestWithS3BucketName (Aws::String &&value)
 
UpdateTrailRequestWithS3BucketName (const char *value)
 
const Aws::StringGetS3KeyPrefix () const
 
bool S3KeyPrefixHasBeenSet () const
 
void SetS3KeyPrefix (const Aws::String &value)
 
void SetS3KeyPrefix (Aws::String &&value)
 
void SetS3KeyPrefix (const char *value)
 
UpdateTrailRequestWithS3KeyPrefix (const Aws::String &value)
 
UpdateTrailRequestWithS3KeyPrefix (Aws::String &&value)
 
UpdateTrailRequestWithS3KeyPrefix (const char *value)
 
const Aws::StringGetSnsTopicName () const
 
bool SnsTopicNameHasBeenSet () const
 
void SetSnsTopicName (const Aws::String &value)
 
void SetSnsTopicName (Aws::String &&value)
 
void SetSnsTopicName (const char *value)
 
UpdateTrailRequestWithSnsTopicName (const Aws::String &value)
 
UpdateTrailRequestWithSnsTopicName (Aws::String &&value)
 
UpdateTrailRequestWithSnsTopicName (const char *value)
 
bool GetIncludeGlobalServiceEvents () const
 
bool IncludeGlobalServiceEventsHasBeenSet () const
 
void SetIncludeGlobalServiceEvents (bool value)
 
UpdateTrailRequestWithIncludeGlobalServiceEvents (bool value)
 
bool GetIsMultiRegionTrail () const
 
bool IsMultiRegionTrailHasBeenSet () const
 
void SetIsMultiRegionTrail (bool value)
 
UpdateTrailRequestWithIsMultiRegionTrail (bool value)
 
bool GetEnableLogFileValidation () const
 
bool EnableLogFileValidationHasBeenSet () const
 
void SetEnableLogFileValidation (bool value)
 
UpdateTrailRequestWithEnableLogFileValidation (bool value)
 
const Aws::StringGetCloudWatchLogsLogGroupArn () const
 
bool CloudWatchLogsLogGroupArnHasBeenSet () const
 
void SetCloudWatchLogsLogGroupArn (const Aws::String &value)
 
void SetCloudWatchLogsLogGroupArn (Aws::String &&value)
 
void SetCloudWatchLogsLogGroupArn (const char *value)
 
UpdateTrailRequestWithCloudWatchLogsLogGroupArn (const Aws::String &value)
 
UpdateTrailRequestWithCloudWatchLogsLogGroupArn (Aws::String &&value)
 
UpdateTrailRequestWithCloudWatchLogsLogGroupArn (const char *value)
 
const Aws::StringGetCloudWatchLogsRoleArn () const
 
bool CloudWatchLogsRoleArnHasBeenSet () const
 
void SetCloudWatchLogsRoleArn (const Aws::String &value)
 
void SetCloudWatchLogsRoleArn (Aws::String &&value)
 
void SetCloudWatchLogsRoleArn (const char *value)
 
UpdateTrailRequestWithCloudWatchLogsRoleArn (const Aws::String &value)
 
UpdateTrailRequestWithCloudWatchLogsRoleArn (Aws::String &&value)
 
UpdateTrailRequestWithCloudWatchLogsRoleArn (const char *value)
 
const Aws::StringGetKmsKeyId () const
 
bool KmsKeyIdHasBeenSet () const
 
void SetKmsKeyId (const Aws::String &value)
 
void SetKmsKeyId (Aws::String &&value)
 
void SetKmsKeyId (const char *value)
 
UpdateTrailRequestWithKmsKeyId (const Aws::String &value)
 
UpdateTrailRequestWithKmsKeyId (Aws::String &&value)
 
UpdateTrailRequestWithKmsKeyId (const char *value)
 
bool GetIsOrganizationTrail () const
 
bool IsOrganizationTrailHasBeenSet () const
 
void SetIsOrganizationTrail (bool value)
 
UpdateTrailRequestWithIsOrganizationTrail (bool value)
 
- Public Member Functions inherited from Aws::CloudTrail::CloudTrailRequest
virtual ~CloudTrailRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Specifies settings to update for the trail.

See Also:

AWS API Reference

Definition at line 24 of file UpdateTrailRequest.h.

Constructor & Destructor Documentation

◆ UpdateTrailRequest()

Aws::CloudTrail::Model::UpdateTrailRequest::UpdateTrailRequest ( )

Member Function Documentation

◆ CloudWatchLogsLogGroupArnHasBeenSet()

bool Aws::CloudTrail::Model::UpdateTrailRequest::CloudWatchLogsLogGroupArnHasBeenSet ( ) const
inline

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. Not required unless you specify CloudWatchLogsRoleArn.

Definition at line 467 of file UpdateTrailRequest.h.

◆ CloudWatchLogsRoleArnHasBeenSet()

bool Aws::CloudTrail::Model::UpdateTrailRequest::CloudWatchLogsRoleArnHasBeenSet ( ) const
inline

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

Definition at line 522 of file UpdateTrailRequest.h.

◆ EnableLogFileValidationHasBeenSet()

bool Aws::CloudTrail::Model::UpdateTrailRequest::EnableLogFileValidationHasBeenSet ( ) const
inline

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

Definition at line 426 of file UpdateTrailRequest.h.

◆ GetCloudWatchLogsLogGroupArn()

const Aws::String& Aws::CloudTrail::Model::UpdateTrailRequest::GetCloudWatchLogsLogGroupArn ( ) const
inline

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. Not required unless you specify CloudWatchLogsRoleArn.

Definition at line 460 of file UpdateTrailRequest.h.

◆ GetCloudWatchLogsRoleArn()

const Aws::String& Aws::CloudTrail::Model::UpdateTrailRequest::GetCloudWatchLogsRoleArn ( ) const
inline

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

Definition at line 516 of file UpdateTrailRequest.h.

◆ GetEnableLogFileValidation()

bool Aws::CloudTrail::Model::UpdateTrailRequest::GetEnableLogFileValidation ( ) const
inline

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

Definition at line 413 of file UpdateTrailRequest.h.

◆ GetIncludeGlobalServiceEvents()

bool Aws::CloudTrail::Model::UpdateTrailRequest::GetIncludeGlobalServiceEvents ( ) const
inline

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

Definition at line 336 of file UpdateTrailRequest.h.

◆ GetIsMultiRegionTrail()

bool Aws::CloudTrail::Model::UpdateTrailRequest::GetIsMultiRegionTrail ( ) const
inline

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.

Definition at line 366 of file UpdateTrailRequest.h.

◆ GetIsOrganizationTrail()

bool Aws::CloudTrail::Model::UpdateTrailRequest::GetIsOrganizationTrail ( ) const
inline

Specifies whether the trail is applied to all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations. If the trail is not an organization trail and this is set to true, the trail will be created in all AWS 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 AWS account but be deleted from all member accounts in the organization.

Definition at line 660 of file UpdateTrailRequest.h.

◆ GetKmsKeyId()

const Aws::String& Aws::CloudTrail::Model::UpdateTrailRequest::GetKmsKeyId ( ) const
inline

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.

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

Definition at line 570 of file UpdateTrailRequest.h.

◆ GetName()

const Aws::String& Aws::CloudTrail::Model::UpdateTrailRequest::GetName ( ) const
inline

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

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

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

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

Definition at line 52 of file UpdateTrailRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::CloudTrail::Model::UpdateTrailRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetS3BucketName()

const Aws::String& Aws::CloudTrail::Model::UpdateTrailRequest::GetS3BucketName ( ) const
inline

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

Definition at line 159 of file UpdateTrailRequest.h.

◆ GetS3KeyPrefix()

const Aws::String& Aws::CloudTrail::Model::UpdateTrailRequest::GetS3KeyPrefix ( ) const
inline

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.

Definition at line 224 of file UpdateTrailRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::CloudTrail::Model::UpdateTrailRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file UpdateTrailRequest.h.

◆ GetSnsTopicName()

const Aws::String& Aws::CloudTrail::Model::UpdateTrailRequest::GetSnsTopicName ( ) const
inline

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

Definition at line 287 of file UpdateTrailRequest.h.

◆ IncludeGlobalServiceEventsHasBeenSet()

bool Aws::CloudTrail::Model::UpdateTrailRequest::IncludeGlobalServiceEventsHasBeenSet ( ) const
inline

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

Definition at line 342 of file UpdateTrailRequest.h.

◆ IsMultiRegionTrailHasBeenSet()

bool Aws::CloudTrail::Model::UpdateTrailRequest::IsMultiRegionTrailHasBeenSet ( ) const
inline

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.

Definition at line 377 of file UpdateTrailRequest.h.

◆ IsOrganizationTrailHasBeenSet()

bool Aws::CloudTrail::Model::UpdateTrailRequest::IsOrganizationTrailHasBeenSet ( ) const
inline

Specifies whether the trail is applied to all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations. If the trail is not an organization trail and this is set to true, the trail will be created in all AWS 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 AWS account but be deleted from all member accounts in the organization.

Definition at line 672 of file UpdateTrailRequest.h.

◆ KmsKeyIdHasBeenSet()

bool Aws::CloudTrail::Model::UpdateTrailRequest::KmsKeyIdHasBeenSet ( ) const
inline

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.

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

Definition at line 581 of file UpdateTrailRequest.h.

◆ NameHasBeenSet()

bool Aws::CloudTrail::Model::UpdateTrailRequest::NameHasBeenSet ( ) const
inline

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

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

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

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

Definition at line 66 of file UpdateTrailRequest.h.

◆ S3BucketNameHasBeenSet()

bool Aws::CloudTrail::Model::UpdateTrailRequest::S3BucketNameHasBeenSet ( ) const
inline

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

Definition at line 167 of file UpdateTrailRequest.h.

◆ S3KeyPrefixHasBeenSet()

bool Aws::CloudTrail::Model::UpdateTrailRequest::S3KeyPrefixHasBeenSet ( ) const
inline

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.

Definition at line 232 of file UpdateTrailRequest.h.

◆ SerializePayload()

Aws::String Aws::CloudTrail::Model::UpdateTrailRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCloudWatchLogsLogGroupArn() [1/3]

void Aws::CloudTrail::Model::UpdateTrailRequest::SetCloudWatchLogsLogGroupArn ( const Aws::String value)
inline

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. Not required unless you specify CloudWatchLogsRoleArn.

Definition at line 474 of file UpdateTrailRequest.h.

◆ SetCloudWatchLogsLogGroupArn() [2/3]

void Aws::CloudTrail::Model::UpdateTrailRequest::SetCloudWatchLogsLogGroupArn ( Aws::String &&  value)
inline

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. Not required unless you specify CloudWatchLogsRoleArn.

Definition at line 481 of file UpdateTrailRequest.h.

◆ SetCloudWatchLogsLogGroupArn() [3/3]

void Aws::CloudTrail::Model::UpdateTrailRequest::SetCloudWatchLogsLogGroupArn ( const char *  value)
inline

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. Not required unless you specify CloudWatchLogsRoleArn.

Definition at line 488 of file UpdateTrailRequest.h.

◆ SetCloudWatchLogsRoleArn() [1/3]

void Aws::CloudTrail::Model::UpdateTrailRequest::SetCloudWatchLogsRoleArn ( const Aws::String value)
inline

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

Definition at line 528 of file UpdateTrailRequest.h.

◆ SetCloudWatchLogsRoleArn() [2/3]

void Aws::CloudTrail::Model::UpdateTrailRequest::SetCloudWatchLogsRoleArn ( Aws::String &&  value)
inline

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

Definition at line 534 of file UpdateTrailRequest.h.

◆ SetCloudWatchLogsRoleArn() [3/3]

void Aws::CloudTrail::Model::UpdateTrailRequest::SetCloudWatchLogsRoleArn ( const char *  value)
inline

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

Definition at line 540 of file UpdateTrailRequest.h.

◆ SetEnableLogFileValidation()

void Aws::CloudTrail::Model::UpdateTrailRequest::SetEnableLogFileValidation ( bool  value)
inline

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

Definition at line 439 of file UpdateTrailRequest.h.

◆ SetIncludeGlobalServiceEvents()

void Aws::CloudTrail::Model::UpdateTrailRequest::SetIncludeGlobalServiceEvents ( bool  value)
inline

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

Definition at line 348 of file UpdateTrailRequest.h.

◆ SetIsMultiRegionTrail()

void Aws::CloudTrail::Model::UpdateTrailRequest::SetIsMultiRegionTrail ( bool  value)
inline

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.

Definition at line 388 of file UpdateTrailRequest.h.

◆ SetIsOrganizationTrail()

void Aws::CloudTrail::Model::UpdateTrailRequest::SetIsOrganizationTrail ( bool  value)
inline

Specifies whether the trail is applied to all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations. If the trail is not an organization trail and this is set to true, the trail will be created in all AWS 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 AWS account but be deleted from all member accounts in the organization.

Definition at line 684 of file UpdateTrailRequest.h.

◆ SetKmsKeyId() [1/3]

void Aws::CloudTrail::Model::UpdateTrailRequest::SetKmsKeyId ( const Aws::String value)
inline

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.

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

Definition at line 592 of file UpdateTrailRequest.h.

◆ SetKmsKeyId() [2/3]

void Aws::CloudTrail::Model::UpdateTrailRequest::SetKmsKeyId ( Aws::String &&  value)
inline

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.

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

Definition at line 603 of file UpdateTrailRequest.h.

◆ SetKmsKeyId() [3/3]

void Aws::CloudTrail::Model::UpdateTrailRequest::SetKmsKeyId ( const char *  value)
inline

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.

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

Definition at line 614 of file UpdateTrailRequest.h.

◆ SetName() [1/3]

void Aws::CloudTrail::Model::UpdateTrailRequest::SetName ( const Aws::String value)
inline

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

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

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

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

Definition at line 80 of file UpdateTrailRequest.h.

◆ SetName() [2/3]

void Aws::CloudTrail::Model::UpdateTrailRequest::SetName ( Aws::String &&  value)
inline

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

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

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

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

Definition at line 94 of file UpdateTrailRequest.h.

◆ SetName() [3/3]

void Aws::CloudTrail::Model::UpdateTrailRequest::SetName ( const char *  value)
inline

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

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

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

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

Definition at line 108 of file UpdateTrailRequest.h.

◆ SetS3BucketName() [1/3]

void Aws::CloudTrail::Model::UpdateTrailRequest::SetS3BucketName ( const Aws::String value)
inline

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

Definition at line 175 of file UpdateTrailRequest.h.

◆ SetS3BucketName() [2/3]

void Aws::CloudTrail::Model::UpdateTrailRequest::SetS3BucketName ( Aws::String &&  value)
inline

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

Definition at line 183 of file UpdateTrailRequest.h.

◆ SetS3BucketName() [3/3]

void Aws::CloudTrail::Model::UpdateTrailRequest::SetS3BucketName ( const char *  value)
inline

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

Definition at line 191 of file UpdateTrailRequest.h.

◆ SetS3KeyPrefix() [1/3]

void Aws::CloudTrail::Model::UpdateTrailRequest::SetS3KeyPrefix ( const Aws::String value)
inline

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.

Definition at line 240 of file UpdateTrailRequest.h.

◆ SetS3KeyPrefix() [2/3]

void Aws::CloudTrail::Model::UpdateTrailRequest::SetS3KeyPrefix ( Aws::String &&  value)
inline

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.

Definition at line 248 of file UpdateTrailRequest.h.

◆ SetS3KeyPrefix() [3/3]

void Aws::CloudTrail::Model::UpdateTrailRequest::SetS3KeyPrefix ( const char *  value)
inline

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.

Definition at line 256 of file UpdateTrailRequest.h.

◆ SetSnsTopicName() [1/3]

void Aws::CloudTrail::Model::UpdateTrailRequest::SetSnsTopicName ( const Aws::String value)
inline

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

Definition at line 299 of file UpdateTrailRequest.h.

◆ SetSnsTopicName() [2/3]

void Aws::CloudTrail::Model::UpdateTrailRequest::SetSnsTopicName ( Aws::String &&  value)
inline

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

Definition at line 305 of file UpdateTrailRequest.h.

◆ SetSnsTopicName() [3/3]

void Aws::CloudTrail::Model::UpdateTrailRequest::SetSnsTopicName ( const char *  value)
inline

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

Definition at line 311 of file UpdateTrailRequest.h.

◆ SnsTopicNameHasBeenSet()

bool Aws::CloudTrail::Model::UpdateTrailRequest::SnsTopicNameHasBeenSet ( ) const
inline

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

Definition at line 293 of file UpdateTrailRequest.h.

◆ WithCloudWatchLogsLogGroupArn() [1/3]

UpdateTrailRequest& Aws::CloudTrail::Model::UpdateTrailRequest::WithCloudWatchLogsLogGroupArn ( const Aws::String value)
inline

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. Not required unless you specify CloudWatchLogsRoleArn.

Definition at line 495 of file UpdateTrailRequest.h.

◆ WithCloudWatchLogsLogGroupArn() [2/3]

UpdateTrailRequest& Aws::CloudTrail::Model::UpdateTrailRequest::WithCloudWatchLogsLogGroupArn ( Aws::String &&  value)
inline

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. Not required unless you specify CloudWatchLogsRoleArn.

Definition at line 502 of file UpdateTrailRequest.h.

◆ WithCloudWatchLogsLogGroupArn() [3/3]

UpdateTrailRequest& Aws::CloudTrail::Model::UpdateTrailRequest::WithCloudWatchLogsLogGroupArn ( const char *  value)
inline

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. Not required unless you specify CloudWatchLogsRoleArn.

Definition at line 509 of file UpdateTrailRequest.h.

◆ WithCloudWatchLogsRoleArn() [1/3]

UpdateTrailRequest& Aws::CloudTrail::Model::UpdateTrailRequest::WithCloudWatchLogsRoleArn ( const Aws::String value)
inline

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

Definition at line 546 of file UpdateTrailRequest.h.

◆ WithCloudWatchLogsRoleArn() [2/3]

UpdateTrailRequest& Aws::CloudTrail::Model::UpdateTrailRequest::WithCloudWatchLogsRoleArn ( Aws::String &&  value)
inline

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

Definition at line 552 of file UpdateTrailRequest.h.

◆ WithCloudWatchLogsRoleArn() [3/3]

UpdateTrailRequest& Aws::CloudTrail::Model::UpdateTrailRequest::WithCloudWatchLogsRoleArn ( const char *  value)
inline

Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.

Definition at line 558 of file UpdateTrailRequest.h.

◆ WithEnableLogFileValidation()

UpdateTrailRequest& Aws::CloudTrail::Model::UpdateTrailRequest::WithEnableLogFileValidation ( bool  value)
inline

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

Definition at line 452 of file UpdateTrailRequest.h.

◆ WithIncludeGlobalServiceEvents()

UpdateTrailRequest& Aws::CloudTrail::Model::UpdateTrailRequest::WithIncludeGlobalServiceEvents ( bool  value)
inline

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

Definition at line 354 of file UpdateTrailRequest.h.

◆ WithIsMultiRegionTrail()

UpdateTrailRequest& Aws::CloudTrail::Model::UpdateTrailRequest::WithIsMultiRegionTrail ( bool  value)
inline

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.

Definition at line 399 of file UpdateTrailRequest.h.

◆ WithIsOrganizationTrail()

UpdateTrailRequest& Aws::CloudTrail::Model::UpdateTrailRequest::WithIsOrganizationTrail ( bool  value)
inline

Specifies whether the trail is applied to all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations. If the trail is not an organization trail and this is set to true, the trail will be created in all AWS 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 AWS account but be deleted from all member accounts in the organization.

Definition at line 696 of file UpdateTrailRequest.h.

◆ WithKmsKeyId() [1/3]

UpdateTrailRequest& Aws::CloudTrail::Model::UpdateTrailRequest::WithKmsKeyId ( const Aws::String value)
inline

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.

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

Definition at line 625 of file UpdateTrailRequest.h.

◆ WithKmsKeyId() [2/3]

UpdateTrailRequest& Aws::CloudTrail::Model::UpdateTrailRequest::WithKmsKeyId ( Aws::String &&  value)
inline

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.

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

Definition at line 636 of file UpdateTrailRequest.h.

◆ WithKmsKeyId() [3/3]

UpdateTrailRequest& Aws::CloudTrail::Model::UpdateTrailRequest::WithKmsKeyId ( const char *  value)
inline

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.

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

Definition at line 647 of file UpdateTrailRequest.h.

◆ WithName() [1/3]

UpdateTrailRequest& Aws::CloudTrail::Model::UpdateTrailRequest::WithName ( const Aws::String value)
inline

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

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

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

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

Definition at line 122 of file UpdateTrailRequest.h.

◆ WithName() [2/3]

UpdateTrailRequest& Aws::CloudTrail::Model::UpdateTrailRequest::WithName ( Aws::String &&  value)
inline

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

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

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

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

Definition at line 136 of file UpdateTrailRequest.h.

◆ WithName() [3/3]

UpdateTrailRequest& Aws::CloudTrail::Model::UpdateTrailRequest::WithName ( const char *  value)
inline

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

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

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

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

Definition at line 150 of file UpdateTrailRequest.h.

◆ WithS3BucketName() [1/3]

UpdateTrailRequest& Aws::CloudTrail::Model::UpdateTrailRequest::WithS3BucketName ( const Aws::String value)
inline

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

Definition at line 199 of file UpdateTrailRequest.h.

◆ WithS3BucketName() [2/3]

UpdateTrailRequest& Aws::CloudTrail::Model::UpdateTrailRequest::WithS3BucketName ( Aws::String &&  value)
inline

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

Definition at line 207 of file UpdateTrailRequest.h.

◆ WithS3BucketName() [3/3]

UpdateTrailRequest& Aws::CloudTrail::Model::UpdateTrailRequest::WithS3BucketName ( const char *  value)
inline

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

Definition at line 215 of file UpdateTrailRequest.h.

◆ WithS3KeyPrefix() [1/3]

UpdateTrailRequest& Aws::CloudTrail::Model::UpdateTrailRequest::WithS3KeyPrefix ( const Aws::String value)
inline

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.

Definition at line 264 of file UpdateTrailRequest.h.

◆ WithS3KeyPrefix() [2/3]

UpdateTrailRequest& Aws::CloudTrail::Model::UpdateTrailRequest::WithS3KeyPrefix ( Aws::String &&  value)
inline

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.

Definition at line 272 of file UpdateTrailRequest.h.

◆ WithS3KeyPrefix() [3/3]

UpdateTrailRequest& Aws::CloudTrail::Model::UpdateTrailRequest::WithS3KeyPrefix ( const char *  value)
inline

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.

Definition at line 280 of file UpdateTrailRequest.h.

◆ WithSnsTopicName() [1/3]

UpdateTrailRequest& Aws::CloudTrail::Model::UpdateTrailRequest::WithSnsTopicName ( const Aws::String value)
inline

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

Definition at line 317 of file UpdateTrailRequest.h.

◆ WithSnsTopicName() [2/3]

UpdateTrailRequest& Aws::CloudTrail::Model::UpdateTrailRequest::WithSnsTopicName ( Aws::String &&  value)
inline

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

Definition at line 323 of file UpdateTrailRequest.h.

◆ WithSnsTopicName() [3/3]

UpdateTrailRequest& Aws::CloudTrail::Model::UpdateTrailRequest::WithSnsTopicName ( const char *  value)
inline

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

Definition at line 329 of file UpdateTrailRequest.h.


The documentation for this class was generated from the following file: