Interface ICfnTrailProps

Properties for defining a CfnTrail.

Namespace: Amazon.CDK.AWS.CloudTrail

Assembly: Amazon.CDK.AWS.CloudTrail.dll

Syntax (csharp)

public interface ICfnTrailProps

Syntax (vb)

Public Interface ICfnTrailProps

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CloudTrail;

CfnTrailProps cfnTrailProps = new CfnTrailProps {
    IsLogging = false,
    S3BucketName = "s3BucketName",

    // the properties below are optional
    CloudWatchLogsLogGroupArn = "cloudWatchLogsLogGroupArn",
    CloudWatchLogsRoleArn = "cloudWatchLogsRoleArn",
    EnableLogFileValidation = false,
    EventSelectors = new [] { new EventSelectorProperty {
        DataResources = new [] { new DataResourceProperty {
            Type = "type",

            // the properties below are optional
            Values = new [] { "values" }
        } },
        ExcludeManagementEventSources = new [] { "excludeManagementEventSources" },
        IncludeManagementEvents = false,
        ReadWriteType = "readWriteType"
    } },
    IncludeGlobalServiceEvents = false,
    InsightSelectors = new [] { new InsightSelectorProperty {
        InsightType = "insightType"
    } },
    IsMultiRegionTrail = false,
    IsOrganizationTrail = false,
    KmsKeyId = "kmsKeyId",
    S3KeyPrefix = "s3KeyPrefix",
    SnsTopicName = "snsTopicName",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    TrailName = "trailName"
};

Synopsis

Properties

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.
CloudWatchLogsRoleArn	Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
EnableLogFileValidation	Specifies whether log file validation is enabled. The default is false.
EventSelectors	Use event selectors to further specify the management and data event settings for your trail.
IncludeGlobalServiceEvents	Specifies whether the trail is publishing events from global services such as IAM to the log files.
InsightSelectors	`AWS::CloudTrail::Trail.InsightSelectors`.
IsLogging	Whether the CloudTrail trail is currently logging AWS API calls.
IsMultiRegionTrail	Specifies whether the trail applies only to the current region or to all regions.
IsOrganizationTrail	Specifies whether the trail is applied to all accounts in an organization in AWS Organizations , or only for the current AWS account .
KmsKeyId	Specifies the AWS KMS key ID to use to encrypt the logs delivered by CloudTrail.
S3BucketName	Specifies the name of the Amazon S3 bucket designated for publishing log files.
S3KeyPrefix	Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery.
SnsTopicName	Specifies the name of the Amazon SNS topic defined for notification of log file delivery.
Tags	A custom set of tags (key-value pairs) for this trail.
TrailName	Specifies the name of the trail. The name must meet the following requirements:.

Properties

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.

virtual string CloudWatchLogsLogGroupArn { get; }

Property Value

System.String

Remarks

Not required unless you specify CloudWatchLogsRoleArn .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-cloudwatchlogsloggrouparn

CloudWatchLogsRoleArn

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

virtual string CloudWatchLogsRoleArn { get; }

Property Value

System.String

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-cloudwatchlogsrolearn

EnableLogFileValidation

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

virtual object EnableLogFileValidation { get; }

Property Value

System.Object

Remarks

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-enablelogfilevalidation

EventSelectors

Use event selectors to further specify the management and data event settings for your trail.

virtual object EventSelectors { get; }

Property Value

System.Object

Remarks

By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.

You can configure up to five event selectors for a trail.

You cannot apply both event selectors and advanced event selectors to a trail.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-eventselectors

IncludeGlobalServiceEvents

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

virtual object IncludeGlobalServiceEvents { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-includeglobalserviceevents

InsightSelectors

AWS::CloudTrail::Trail.InsightSelectors.

virtual object InsightSelectors { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-insightselectors

IsLogging

Whether the CloudTrail trail is currently logging AWS API calls.

object IsLogging { get; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-islogging

IsMultiRegionTrail

Specifies whether the trail applies only to the current region or to all regions.

virtual object IsMultiRegionTrail { get; }

Property Value

System.Object

Remarks

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-ismultiregiontrail

IsOrganizationTrail

Specifies whether the trail is applied to all accounts in an organization in AWS Organizations , or only for the current AWS account .

virtual object IsOrganizationTrail { get; }

Property Value

System.Object

Remarks

The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the management 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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-isorganizationtrail

KmsKeyId

Specifies the AWS KMS key ID to use to encrypt the logs delivered by CloudTrail.

virtual string KmsKeyId { get; }

Property Value

System.String

Remarks

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 AWS KMS multi-Region keys. For more information about multi-Region keys, see Using multi-Region keys in the AWS Key Management Service Developer Guide .

Examples:

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudtrail-trail.html#cfn-cloudtrail-trail-kmskeyid