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

#include <CreateTrailRequest.h>

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

Public Member Functions

 CreateTrailRequest ()
 
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)
 
CreateTrailRequestWithName (const Aws::String &value)
 
CreateTrailRequestWithName (Aws::String &&value)
 
CreateTrailRequestWithName (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)
 
CreateTrailRequestWithS3BucketName (const Aws::String &value)
 
CreateTrailRequestWithS3BucketName (Aws::String &&value)
 
CreateTrailRequestWithS3BucketName (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)
 
CreateTrailRequestWithS3KeyPrefix (const Aws::String &value)
 
CreateTrailRequestWithS3KeyPrefix (Aws::String &&value)
 
CreateTrailRequestWithS3KeyPrefix (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)
 
CreateTrailRequestWithSnsTopicName (const Aws::String &value)
 
CreateTrailRequestWithSnsTopicName (Aws::String &&value)
 
CreateTrailRequestWithSnsTopicName (const char *value)
 
bool GetIncludeGlobalServiceEvents () const
 
bool IncludeGlobalServiceEventsHasBeenSet () const
 
void SetIncludeGlobalServiceEvents (bool value)
 
CreateTrailRequestWithIncludeGlobalServiceEvents (bool value)
 
bool GetIsMultiRegionTrail () const
 
bool IsMultiRegionTrailHasBeenSet () const
 
void SetIsMultiRegionTrail (bool value)
 
CreateTrailRequestWithIsMultiRegionTrail (bool value)
 
bool GetEnableLogFileValidation () const
 
bool EnableLogFileValidationHasBeenSet () const
 
void SetEnableLogFileValidation (bool value)
 
CreateTrailRequestWithEnableLogFileValidation (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)
 
CreateTrailRequestWithCloudWatchLogsLogGroupArn (const Aws::String &value)
 
CreateTrailRequestWithCloudWatchLogsLogGroupArn (Aws::String &&value)
 
CreateTrailRequestWithCloudWatchLogsLogGroupArn (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)
 
CreateTrailRequestWithCloudWatchLogsRoleArn (const Aws::String &value)
 
CreateTrailRequestWithCloudWatchLogsRoleArn (Aws::String &&value)
 
CreateTrailRequestWithCloudWatchLogsRoleArn (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)
 
CreateTrailRequestWithKmsKeyId (const Aws::String &value)
 
CreateTrailRequestWithKmsKeyId (Aws::String &&value)
 
CreateTrailRequestWithKmsKeyId (const char *value)
 
bool GetIsOrganizationTrail () const
 
bool IsOrganizationTrailHasBeenSet () const
 
void SetIsOrganizationTrail (bool value)
 
CreateTrailRequestWithIsOrganizationTrail (bool value)
 
const Aws::Vector< Tag > & GetTagsList () const
 
bool TagsListHasBeenSet () const
 
void SetTagsList (const Aws::Vector< Tag > &value)
 
void SetTagsList (Aws::Vector< Tag > &&value)
 
CreateTrailRequestWithTagsList (const Aws::Vector< Tag > &value)
 
CreateTrailRequestWithTagsList (Aws::Vector< Tag > &&value)
 
CreateTrailRequestAddTagsList (const Tag &value)
 
CreateTrailRequestAddTagsList (Tag &&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 the settings for each trail.

See Also:

AWS API Reference

Definition at line 26 of file CreateTrailRequest.h.

Constructor & Destructor Documentation

◆ CreateTrailRequest()

Aws::CloudTrail::Model::CreateTrailRequest::CreateTrailRequest ( )

Member Function Documentation

◆ AddTagsList() [1/2]

CreateTrailRequest& Aws::CloudTrail::Model::CreateTrailRequest::AddTagsList ( const Tag value)
inline

Definition at line 676 of file CreateTrailRequest.h.

◆ AddTagsList() [2/2]

CreateTrailRequest& Aws::CloudTrail::Model::CreateTrailRequest::AddTagsList ( Tag &&  value)
inline

Definition at line 679 of file CreateTrailRequest.h.

◆ CloudWatchLogsLogGroupArnHasBeenSet()

bool Aws::CloudTrail::Model::CreateTrailRequest::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 441 of file CreateTrailRequest.h.

◆ CloudWatchLogsRoleArnHasBeenSet()

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

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

Definition at line 496 of file CreateTrailRequest.h.

◆ EnableLogFileValidationHasBeenSet()

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

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 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 400 of file CreateTrailRequest.h.

◆ GetCloudWatchLogsLogGroupArn()

const Aws::String& Aws::CloudTrail::Model::CreateTrailRequest::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 434 of file CreateTrailRequest.h.

◆ GetCloudWatchLogsRoleArn()

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

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

Definition at line 490 of file CreateTrailRequest.h.

◆ GetEnableLogFileValidation()

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

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 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 387 of file CreateTrailRequest.h.

◆ GetIncludeGlobalServiceEvents()

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

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

Definition at line 322 of file CreateTrailRequest.h.

◆ GetIsMultiRegionTrail()

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

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.

Definition at line 349 of file CreateTrailRequest.h.

◆ GetIsOrganizationTrail()

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

Specifies whether the trail is created for 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.

Definition at line 630 of file CreateTrailRequest.h.

◆ GetKmsKeyId()

const Aws::String& Aws::CloudTrail::Model::CreateTrailRequest::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 544 of file CreateTrailRequest.h.

◆ GetName()

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

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

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

Definition at line 52 of file CreateTrailRequest.h.

◆ GetRequestSpecificHeaders()

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

◆ GetS3BucketName()

const Aws::String& Aws::CloudTrail::Model::CreateTrailRequest::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 145 of file CreateTrailRequest.h.

◆ GetS3KeyPrefix()

const Aws::String& Aws::CloudTrail::Model::CreateTrailRequest::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 210 of file CreateTrailRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file CreateTrailRequest.h.

◆ GetSnsTopicName()

const Aws::String& Aws::CloudTrail::Model::CreateTrailRequest::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 273 of file CreateTrailRequest.h.

◆ GetTagsList()

const Aws::Vector<Tag>& Aws::CloudTrail::Model::CreateTrailRequest::GetTagsList ( ) const
inline

Definition at line 658 of file CreateTrailRequest.h.

◆ IncludeGlobalServiceEventsHasBeenSet()

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

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

Definition at line 328 of file CreateTrailRequest.h.

◆ IsMultiRegionTrailHasBeenSet()

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

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.

Definition at line 357 of file CreateTrailRequest.h.

◆ IsOrganizationTrailHasBeenSet()

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

Specifies whether the trail is created for 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.

Definition at line 638 of file CreateTrailRequest.h.

◆ KmsKeyIdHasBeenSet()

bool Aws::CloudTrail::Model::CreateTrailRequest::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 555 of file CreateTrailRequest.h.

◆ NameHasBeenSet()

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

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

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

Definition at line 64 of file CreateTrailRequest.h.

◆ S3BucketNameHasBeenSet()

bool Aws::CloudTrail::Model::CreateTrailRequest::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 153 of file CreateTrailRequest.h.

◆ S3KeyPrefixHasBeenSet()

bool Aws::CloudTrail::Model::CreateTrailRequest::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 218 of file CreateTrailRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCloudWatchLogsLogGroupArn() [1/3]

void Aws::CloudTrail::Model::CreateTrailRequest::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 448 of file CreateTrailRequest.h.

◆ SetCloudWatchLogsLogGroupArn() [2/3]

void Aws::CloudTrail::Model::CreateTrailRequest::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 455 of file CreateTrailRequest.h.

◆ SetCloudWatchLogsLogGroupArn() [3/3]

void Aws::CloudTrail::Model::CreateTrailRequest::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 462 of file CreateTrailRequest.h.

◆ SetCloudWatchLogsRoleArn() [1/3]

void Aws::CloudTrail::Model::CreateTrailRequest::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 502 of file CreateTrailRequest.h.

◆ SetCloudWatchLogsRoleArn() [2/3]

void Aws::CloudTrail::Model::CreateTrailRequest::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 508 of file CreateTrailRequest.h.

◆ SetCloudWatchLogsRoleArn() [3/3]

void Aws::CloudTrail::Model::CreateTrailRequest::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 514 of file CreateTrailRequest.h.

◆ SetEnableLogFileValidation()

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

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

◆ SetIncludeGlobalServiceEvents()

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

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

Definition at line 334 of file CreateTrailRequest.h.

◆ SetIsMultiRegionTrail()

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

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.

Definition at line 365 of file CreateTrailRequest.h.

◆ SetIsOrganizationTrail()

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

Specifies whether the trail is created for 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.

Definition at line 646 of file CreateTrailRequest.h.

◆ SetKmsKeyId() [1/3]

void Aws::CloudTrail::Model::CreateTrailRequest::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 566 of file CreateTrailRequest.h.

◆ SetKmsKeyId() [2/3]

void Aws::CloudTrail::Model::CreateTrailRequest::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 577 of file CreateTrailRequest.h.

◆ SetKmsKeyId() [3/3]

void Aws::CloudTrail::Model::CreateTrailRequest::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 588 of file CreateTrailRequest.h.

◆ SetName() [1/3]

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

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

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

Definition at line 76 of file CreateTrailRequest.h.

◆ SetName() [2/3]

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

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

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

Definition at line 88 of file CreateTrailRequest.h.

◆ SetName() [3/3]

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

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

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

Definition at line 100 of file CreateTrailRequest.h.

◆ SetS3BucketName() [1/3]

void Aws::CloudTrail::Model::CreateTrailRequest::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 161 of file CreateTrailRequest.h.

◆ SetS3BucketName() [2/3]

void Aws::CloudTrail::Model::CreateTrailRequest::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 169 of file CreateTrailRequest.h.

◆ SetS3BucketName() [3/3]

void Aws::CloudTrail::Model::CreateTrailRequest::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 177 of file CreateTrailRequest.h.

◆ SetS3KeyPrefix() [1/3]

void Aws::CloudTrail::Model::CreateTrailRequest::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 226 of file CreateTrailRequest.h.

◆ SetS3KeyPrefix() [2/3]

void Aws::CloudTrail::Model::CreateTrailRequest::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 234 of file CreateTrailRequest.h.

◆ SetS3KeyPrefix() [3/3]

void Aws::CloudTrail::Model::CreateTrailRequest::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 242 of file CreateTrailRequest.h.

◆ SetSnsTopicName() [1/3]

void Aws::CloudTrail::Model::CreateTrailRequest::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 285 of file CreateTrailRequest.h.

◆ SetSnsTopicName() [2/3]

void Aws::CloudTrail::Model::CreateTrailRequest::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 291 of file CreateTrailRequest.h.

◆ SetSnsTopicName() [3/3]

void Aws::CloudTrail::Model::CreateTrailRequest::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 297 of file CreateTrailRequest.h.

◆ SetTagsList() [1/2]

void Aws::CloudTrail::Model::CreateTrailRequest::SetTagsList ( const Aws::Vector< Tag > &  value)
inline

Definition at line 664 of file CreateTrailRequest.h.

◆ SetTagsList() [2/2]

void Aws::CloudTrail::Model::CreateTrailRequest::SetTagsList ( Aws::Vector< Tag > &&  value)
inline

Definition at line 667 of file CreateTrailRequest.h.

◆ SnsTopicNameHasBeenSet()

bool Aws::CloudTrail::Model::CreateTrailRequest::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 279 of file CreateTrailRequest.h.

◆ TagsListHasBeenSet()

bool Aws::CloudTrail::Model::CreateTrailRequest::TagsListHasBeenSet ( ) const
inline

Definition at line 661 of file CreateTrailRequest.h.

◆ WithCloudWatchLogsLogGroupArn() [1/3]

CreateTrailRequest& Aws::CloudTrail::Model::CreateTrailRequest::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 469 of file CreateTrailRequest.h.

◆ WithCloudWatchLogsLogGroupArn() [2/3]

CreateTrailRequest& Aws::CloudTrail::Model::CreateTrailRequest::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 476 of file CreateTrailRequest.h.

◆ WithCloudWatchLogsLogGroupArn() [3/3]

CreateTrailRequest& Aws::CloudTrail::Model::CreateTrailRequest::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 483 of file CreateTrailRequest.h.

◆ WithCloudWatchLogsRoleArn() [1/3]

CreateTrailRequest& Aws::CloudTrail::Model::CreateTrailRequest::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 520 of file CreateTrailRequest.h.

◆ WithCloudWatchLogsRoleArn() [2/3]

CreateTrailRequest& Aws::CloudTrail::Model::CreateTrailRequest::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 526 of file CreateTrailRequest.h.

◆ WithCloudWatchLogsRoleArn() [3/3]

CreateTrailRequest& Aws::CloudTrail::Model::CreateTrailRequest::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 532 of file CreateTrailRequest.h.

◆ WithEnableLogFileValidation()

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

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

◆ WithIncludeGlobalServiceEvents()

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

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

Definition at line 340 of file CreateTrailRequest.h.

◆ WithIsMultiRegionTrail()

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

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.

Definition at line 373 of file CreateTrailRequest.h.

◆ WithIsOrganizationTrail()

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

Specifies whether the trail is created for 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.

Definition at line 654 of file CreateTrailRequest.h.

◆ WithKmsKeyId() [1/3]

CreateTrailRequest& Aws::CloudTrail::Model::CreateTrailRequest::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 599 of file CreateTrailRequest.h.

◆ WithKmsKeyId() [2/3]

CreateTrailRequest& Aws::CloudTrail::Model::CreateTrailRequest::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 610 of file CreateTrailRequest.h.

◆ WithKmsKeyId() [3/3]

CreateTrailRequest& Aws::CloudTrail::Model::CreateTrailRequest::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 621 of file CreateTrailRequest.h.

◆ WithName() [1/3]

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

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

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

Definition at line 112 of file CreateTrailRequest.h.

◆ WithName() [2/3]

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

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

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

Definition at line 124 of file CreateTrailRequest.h.

◆ WithName() [3/3]

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

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

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

Definition at line 136 of file CreateTrailRequest.h.

◆ WithS3BucketName() [1/3]

CreateTrailRequest& Aws::CloudTrail::Model::CreateTrailRequest::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 185 of file CreateTrailRequest.h.

◆ WithS3BucketName() [2/3]

CreateTrailRequest& Aws::CloudTrail::Model::CreateTrailRequest::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 193 of file CreateTrailRequest.h.

◆ WithS3BucketName() [3/3]

CreateTrailRequest& Aws::CloudTrail::Model::CreateTrailRequest::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 201 of file CreateTrailRequest.h.

◆ WithS3KeyPrefix() [1/3]

CreateTrailRequest& Aws::CloudTrail::Model::CreateTrailRequest::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 250 of file CreateTrailRequest.h.

◆ WithS3KeyPrefix() [2/3]

CreateTrailRequest& Aws::CloudTrail::Model::CreateTrailRequest::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 258 of file CreateTrailRequest.h.

◆ WithS3KeyPrefix() [3/3]

CreateTrailRequest& Aws::CloudTrail::Model::CreateTrailRequest::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 266 of file CreateTrailRequest.h.

◆ WithSnsTopicName() [1/3]

CreateTrailRequest& Aws::CloudTrail::Model::CreateTrailRequest::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 303 of file CreateTrailRequest.h.

◆ WithSnsTopicName() [2/3]

CreateTrailRequest& Aws::CloudTrail::Model::CreateTrailRequest::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 309 of file CreateTrailRequest.h.

◆ WithSnsTopicName() [3/3]

CreateTrailRequest& Aws::CloudTrail::Model::CreateTrailRequest::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 315 of file CreateTrailRequest.h.

◆ WithTagsList() [1/2]

CreateTrailRequest& Aws::CloudTrail::Model::CreateTrailRequest::WithTagsList ( const Aws::Vector< Tag > &  value)
inline

Definition at line 670 of file CreateTrailRequest.h.

◆ WithTagsList() [2/2]

CreateTrailRequest& Aws::CloudTrail::Model::CreateTrailRequest::WithTagsList ( Aws::Vector< Tag > &&  value)
inline

Definition at line 673 of file CreateTrailRequest.h.


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