< Back
Add-CfnCloudTrail_TrailResource
Post
NAME Add-CfnCloudTrail_TrailResource
SYNOPSIS
The AWS::CloudTrail::Trail resource creates a trail and specifies where logs are published.
SYNTAX
Add-CfnCloudTrail_TrailResource [-ResourceName] <String> [-CloudWatchLogsLogGroupArn <String>]
[-CloudWatchLogsRoleArn <String>] [-EnableLogFileValidation <Boolean>] [-IncludeGlobalServiceEvents <Boolean>]
[-IsLogging <Boolean>] [-IsMultiRegionTrail <Boolean>] [-KMSKeyId <String>] [-S3BucketName <String>] [-S3KeyPrefix
<String>] [-SnsTopicName <String>] [-Tags <IDictionary>] [-DeletionPolicy <String>] [-Metadata <Hashtable>]
[-DependsOn <Array>] [[-PropertiesBlock] <ScriptBlock>] [-Condition <Object>] [<CommonParameters>]
DESCRIPTION
PARAMETERS
-ResourceName <String>
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CloudWatchLogsLogGroupArn <String>
The Amazon Resource Name (ARN) of a log group to which CloudTrail logs will be delivered.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CloudWatchLogsRoleArn <String>
The role ARN that Amazon CloudWatch Logs (CloudWatch Logs) assumes to write logs to a log group.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EnableLogFileValidation <Boolean>
Indicates whether CloudTrail validates the integrity of log files. When you disable log file integrity
validation, CloudTrail stops creating digest files.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-IncludeGlobalServiceEvents <Boolean>
Indicates whether the trail is publishing events from global services, such as IAM, to the log files.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-IsLogging <Boolean>
Indicates whether the CloudTrail trail is currently logging AWS API calls.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-IsMultiRegionTrail <Boolean>
Indicates whether the CloudTrail trail is created in the region in which you create the stack (false) or in
all regions (true).
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-KMSKeyId <String>
The AWS Key Management Service (AWS KMS) key ID that you want to use to encrypt CloudTrail logs.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-S3BucketName <String>
The name of the Amazon S3 bucket where CloudTrail publishes log files.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-S3KeyPrefix <String>
An Amazon S3 object key prefix that precedes the name of all log files.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SnsTopicName <String>
The name of an Amazon SNS topic that is notified when new log files are published.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Tags <IDictionary>
The tags that you want to attach.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DeletionPolicy <String>
With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is
deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has
no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default.
To keep a resource when its stack is deleted, specify Retain for that resource. You can use retain for any
resource. For example, you can retain a nested stack, S3 bucket, or EC2 instance so that you can continue to
use or modify those resources after you delete their stacks.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Metadata <Hashtable>
The Metadata attribute enables you to associate structured data with a resource. By adding a Metadata
attribute to a resource, you can add data in JSON format to the resource declaration. In addition, you can use
intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the Metadata attribute
to add those interpreted values.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DependsOn <Array>
With the DependsOn attribute you can specify that the creation of a specific resource follows another. When
you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource
specified in the DependsOn attribute. You can use the DependsOn attribute with any resource.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PropertiesBlock <ScriptBlock>
Allows you to declare a block of one or more Property statements.
A Properties block allows you to side-step the rigid, type-enforced literal properties of a typed resource,
and specify Property assignments that may include CloudFormation function calls or references, or computed
values.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Condition <Object>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
RELATED LINKS
http://docs.aws.amazon.com/AWSCloudForm ... olicy.html
http://docs.aws.amazon.com/AWSCloudForm ... adata.html
http://docs.aws.amazon.com/AWSCloudForm ... ndson.html
http://docs.aws.amazon.com/AWSCloudForm ... e-ref.html
http://docs.aws.amazon.com/search/doc-s ... ail::Trail
SYNOPSIS
The AWS::CloudTrail::Trail resource creates a trail and specifies where logs are published.
SYNTAX
Add-CfnCloudTrail_TrailResource [-ResourceName] <String> [-CloudWatchLogsLogGroupArn <String>]
[-CloudWatchLogsRoleArn <String>] [-EnableLogFileValidation <Boolean>] [-IncludeGlobalServiceEvents <Boolean>]
[-IsLogging <Boolean>] [-IsMultiRegionTrail <Boolean>] [-KMSKeyId <String>] [-S3BucketName <String>] [-S3KeyPrefix
<String>] [-SnsTopicName <String>] [-Tags <IDictionary>] [-DeletionPolicy <String>] [-Metadata <Hashtable>]
[-DependsOn <Array>] [[-PropertiesBlock] <ScriptBlock>] [-Condition <Object>] [<CommonParameters>]
DESCRIPTION
PARAMETERS
-ResourceName <String>
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CloudWatchLogsLogGroupArn <String>
The Amazon Resource Name (ARN) of a log group to which CloudTrail logs will be delivered.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CloudWatchLogsRoleArn <String>
The role ARN that Amazon CloudWatch Logs (CloudWatch Logs) assumes to write logs to a log group.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EnableLogFileValidation <Boolean>
Indicates whether CloudTrail validates the integrity of log files. When you disable log file integrity
validation, CloudTrail stops creating digest files.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-IncludeGlobalServiceEvents <Boolean>
Indicates whether the trail is publishing events from global services, such as IAM, to the log files.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-IsLogging <Boolean>
Indicates whether the CloudTrail trail is currently logging AWS API calls.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-IsMultiRegionTrail <Boolean>
Indicates whether the CloudTrail trail is created in the region in which you create the stack (false) or in
all regions (true).
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-KMSKeyId <String>
The AWS Key Management Service (AWS KMS) key ID that you want to use to encrypt CloudTrail logs.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-S3BucketName <String>
The name of the Amazon S3 bucket where CloudTrail publishes log files.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-S3KeyPrefix <String>
An Amazon S3 object key prefix that precedes the name of all log files.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-SnsTopicName <String>
The name of an Amazon SNS topic that is notified when new log files are published.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Tags <IDictionary>
The tags that you want to attach.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DeletionPolicy <String>
With the DeletionPolicy attribute you can preserve or (in some cases) backup a resource when its stack is
deleted. You specify a DeletionPolicy attribute for each resource that you want to control. If a resource has
no DeletionPolicy attribute, AWS CloudFormation deletes the resource by default.
To keep a resource when its stack is deleted, specify Retain for that resource. You can use retain for any
resource. For example, you can retain a nested stack, S3 bucket, or EC2 instance so that you can continue to
use or modify those resources after you delete their stacks.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Metadata <Hashtable>
The Metadata attribute enables you to associate structured data with a resource. By adding a Metadata
attribute to a resource, you can add data in JSON format to the resource declaration. In addition, you can use
intrinsic functions (such as GetAtt and Ref), parameters, and pseudo parameters within the Metadata attribute
to add those interpreted values.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DependsOn <Array>
With the DependsOn attribute you can specify that the creation of a specific resource follows another. When
you add a DependsOn attribute to a resource, that resource is created only after the creation of the resource
specified in the DependsOn attribute. You can use the DependsOn attribute with any resource.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-PropertiesBlock <ScriptBlock>
Allows you to declare a block of one or more Property statements.
A Properties block allows you to side-step the rigid, type-enforced literal properties of a typed resource,
and specify Property assignments that may include CloudFormation function calls or references, or computed
values.
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Condition <Object>
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
RELATED LINKS
http://docs.aws.amazon.com/AWSCloudForm ... olicy.html
http://docs.aws.amazon.com/AWSCloudForm ... adata.html
http://docs.aws.amazon.com/AWSCloudForm ... ndson.html
http://docs.aws.amazon.com/AWSCloudForm ... e-ref.html
http://docs.aws.amazon.com/search/doc-s ... ail::Trail