Class CfnTrail
A CloudFormation AWS::CloudTrail::Trail.
Inherited Members
Namespace: Amazon.CDK.AWS.CloudTrail
Assembly: Amazon.CDK.AWS.CloudTrail.dll
Syntax (csharp)
public class CfnTrail : CfnResource, IConstruct, IDependable, IInspectableSyntax (vb)
Public Class CfnTrail
Inherits CfnResource
Implements IConstruct, IDependable, IInspectableRemarks
Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket.
CloudformationResource: AWS::CloudTrail::Trail
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;
var cfnTrail = new CfnTrail(this, "MyCfnTrail", new CfnTrailProps {
IsLogging = false,
S3BucketName = "s3BucketName",
// the properties below are optional
AdvancedEventSelectors = new [] { new AdvancedEventSelectorProperty {
FieldSelectors = new [] { new AdvancedFieldSelectorProperty {
Field = "field",
// the properties below are optional
EndsWith = new [] { "endsWith" },
EqualTo = new [] { "equalTo" },
NotEndsWith = new [] { "notEndsWith" },
NotEquals = new [] { "notEquals" },
NotStartsWith = new [] { "notStartsWith" },
StartsWith = new [] { "startsWith" }
} },
// the properties below are optional
Name = "name"
} },
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
Constructors
| CfnTrail(Construct, String, ICfnTrailProps) | Create a new |
| CfnTrail(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
| CfnTrail(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
| AdvancedEventSelectors | Specifies the settings for advanced event selectors. |
| AttrArn |
|
| AttrSnsTopicArn |
|
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| CfnProperties | |
| 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 | A JSON string that contains the insight types you want to log on a trail. |
| 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:. |
Methods
| Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
| RenderProperties(IDictionary<String, Object>) |
Constructors
CfnTrail(Construct, String, ICfnTrailProps)
Create a new AWS::CloudTrail::Trail.
public CfnTrail(Construct scope, string id, ICfnTrailProps props)Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnTrailProps
- resource properties.
CfnTrail(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnTrail(ByRefValue reference)Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnTrail(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnTrail(DeputyBase.DeputyProps props)Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AdvancedEventSelectors
Specifies the settings for advanced event selectors.
public virtual object AdvancedEventSelectors { get; set; }Property Value
System.Object
Remarks
You can add advanced event selectors, and conditions for your advanced event selectors, up to a maximum of 500 values for all conditions and selectors on a trail. You can use either AdvancedEventSelectors or EventSelectors , but not both. If you apply AdvancedEventSelectors to a trail, any existing EventSelectors are overwritten. For more information about advanced event selectors, see Logging data events in the AWS CloudTrail User Guide .
AttrArn
Ref returns the ARN of the CloudTrail trail, such as arn:aws:cloudtrail:us-east-2:123456789012:trail/myCloudTrail .
public virtual string AttrArn { get; }Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrSnsTopicArn
Ref returns the ARN of the Amazon SNS topic that's associated with the CloudTrail trail, such as arn:aws:sns:us-east-2:123456789012:mySNSTopic .
public virtual string AttrSnsTopicArn { get; }Property Value
System.String
Remarks
CloudformationAttribute: SnsTopicArn
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
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.
public virtual string CloudWatchLogsLogGroupArn { get; set; }Property Value
System.String
Remarks
You must use a log group that exists in your account.
Not required unless you specify CloudWatchLogsRoleArn .
CloudWatchLogsRoleArn
Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.
public virtual string CloudWatchLogsRoleArn { get; set; }Property Value
System.String
Remarks
You must use a role that exists in your account.
EnableLogFileValidation
Specifies whether log file validation is enabled. The default is false.
public virtual object EnableLogFileValidation { get; set; }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.
EventSelectors
Use event selectors to further specify the management and data event settings for your trail.
public virtual object EventSelectors { get; set; }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.
For more information about how to configure event selectors, see Examples and Configuring event selectors in the AWS CloudTrail User Guide .
IncludeGlobalServiceEvents
Specifies whether the trail is publishing events from global services such as IAM to the log files.
public virtual object IncludeGlobalServiceEvents { get; set; }Property Value
System.Object
Remarks
InsightSelectors
A JSON string that contains the insight types you want to log on a trail.
public virtual object InsightSelectors { get; set; }Property Value
System.Object
Remarks
ApiCallRateInsight and ApiErrorRateInsight are valid Insight types.
The ApiCallRateInsight Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume.
The ApiErrorRateInsight Insights type analyzes management API calls that result in error codes. The error is shown if the API call is unsuccessful.
IsLogging
Whether the CloudTrail trail is currently logging AWS API calls.
public virtual object IsLogging { get; set; }Property Value
System.Object
Remarks
IsMultiRegionTrail
Specifies whether the trail applies only to the current Region or to all Regions.
public virtual object IsMultiRegionTrail { get; set; }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.
IsOrganizationTrail
Specifies whether the trail is applied to all accounts in an organization in AWS Organizations , or only for the current AWS account .
public virtual object IsOrganizationTrail { get; set; }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 or delegated administrator 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.
KmsKeyId
Specifies the AWS KMS key ID to use to encrypt the logs delivered by CloudTrail.
public virtual string KmsKeyId { get; set; }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:
S3BucketName
Specifies the name of the Amazon S3 bucket designated for publishing log files.
public virtual string S3BucketName { get; set; }Property Value
System.String
Remarks
S3KeyPrefix
Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery.
public virtual string S3KeyPrefix { get; set; }Property Value
System.String
Remarks
For more information, see Finding Your CloudTrail Log Files . The maximum length is 200 characters.
SnsTopicName
Specifies the name of the Amazon SNS topic defined for notification of log file delivery.
public virtual string SnsTopicName { get; set; }Property Value
System.String
Remarks
The maximum length is 256 characters.
Tags
A custom set of tags (key-value pairs) for this trail.
public virtual TagManager Tags { get; }Property Value
Remarks
TrailName
Specifies the name of the trail. The name must meet the following requirements:.
public virtual string TrailName { get; set; }Property Value
System.String
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>