AWS.Tools.CloudTrail.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.CloudTrail</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.CT.AddCTResourceTagCmdlet"> <summary> Adds one or more tags to a trail, up to a limit of 50. Overwrites an existing tag's value when a new value is specified for an existing tag key. Tag key names must be unique for a trail; you cannot have two keys with the same name but different values. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail that applies to all AWS Regions only from the Region in which the trail was created (also known as its home region). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.AddCTResourceTagCmdlet.ResourceId"> <summary> <para> <para>Specifies the ARN of the trail to which one or more tags will be added. The format of a trail ARN is:</para><para><code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.AddCTResourceTagCmdlet.TagsList"> <summary> <para> <para>Contains a list of CloudTrail tags, up to a limit of 50</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.AddCTResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudTrail.Model.AddTagsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.AddCTResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceId parameter. The -PassThru parameter is deprecated, use -Select '^ResourceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.AddCTResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CT.FindCTEventCmdlet"> <summary> Looks up <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html#cloudtrail-concepts-management-events">management events</a> or <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-concepts.html#cloudtrail-concepts-insights-events">CloudTrail Insights events</a> that are captured by CloudTrail. You can look up events that occurred in a region within the last 90 days. Lookup supports the following attributes for management events: <ul><li><para> AWS access key </para></li><li><para> Event ID </para></li><li><para> Event name </para></li><li><para> Event source </para></li><li><para> Read only </para></li><li><para> Resource name </para></li><li><para> Resource type </para></li><li><para> User name </para></li></ul><para> Lookup supports the following attributes for Insights events: </para><ul><li><para> Event ID </para></li><li><para> Event name </para></li><li><para> Event source </para></li></ul><para> All attributes are optional. The default number of results returned is 50, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results. </para><important><para> The rate of lookup requests is limited to two per second, per account, per region. If this limit is exceeded, a throttling error occurs. </para></important><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.FindCTEventCmdlet.EndTime"> <summary> <para> <para>Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.FindCTEventCmdlet.EventCategory"> <summary> <para> <para>Specifies the event category. If you do not specify an event category, events of the category are not returned in the response. For example, if you do not specify <code>insight</code> as the value of <code>EventCategory</code>, no Insights events are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.FindCTEventCmdlet.LookupAttribute"> <summary> <para> <para>Contains a list of lookup attributes. Currently the list can contain only one item.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.FindCTEventCmdlet.StartTime"> <summary> <para> <para>Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.FindCTEventCmdlet.MaxResult"> <summary> <para> <para>The number of events to return. Possible values are 1 through 50. The default is 50.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.FindCTEventCmdlet.NextToken"> <summary> <para> <para>The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.FindCTEventCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Events'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudTrail.Model.LookupEventsResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.LookupEventsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.FindCTEventCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CT.GetCTEventSelectorCmdlet"> <summary> Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following: <ul><li><para> If your event selector includes read-only events, write-only events, or all events. This applies to both management events and data events. </para></li><li><para> If your event selector includes management events. </para></li><li><para> If your event selector includes data events, the Amazon S3 objects or AWS Lambda functions that you are logging for data events. </para></li></ul><para> For more information, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html">Logging Data and Management Events for Trails </a> in the <i>AWS CloudTrail User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTEventSelectorCmdlet.TrailName"> <summary> <para> <para>Specifies the name of the trail or trail ARN. If you specify a trail name, the string must meet the following requirements:</para><ul><li><para>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</para></li><li><para>Start with a letter or number, and end with a letter or number</para></li><li><para>Be between 3 and 128 characters</para></li><li><para>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are not valid.</para></li><li><para>Not be in IP address format (for example, 192.168.5.4)</para></li></ul><para>If you specify a trail ARN, it must be in the format:</para><para><code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTEventSelectorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudTrail.Model.GetEventSelectorsResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.GetEventSelectorsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTEventSelectorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrailName parameter. The -PassThru parameter is deprecated, use -Select '^TrailName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CT.GetCTInsightSelectorCmdlet"> <summary> Describes the settings for the Insights event selectors that you configured for your trail. <code>GetInsightSelectors</code> shows if CloudTrail Insights event logging is enabled on the trail, and if it is, which insight types are enabled. If you run <code>GetInsightSelectors</code> on a trail that does not have Insights events enabled, the operation throws the exception <code>InsightNotEnabledException</code><para> For more information, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-insights-events-with-cloudtrail.html">Logging CloudTrail Insights Events for Trails </a> in the <i>AWS CloudTrail User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTInsightSelectorCmdlet.TrailName"> <summary> <para> <para>Specifies the name of the trail or trail ARN. If you specify a trail name, the string must meet the following requirements:</para><ul><li><para>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</para></li><li><para>Start with a letter or number, and end with a letter or number</para></li><li><para>Be between 3 and 128 characters</para></li><li><para>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are not valid.</para></li><li><para>Not be in IP address format (for example, 192.168.5.4)</para></li></ul><para>If you specify a trail ARN, it must be in the format:</para><para><code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTInsightSelectorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudTrail.Model.GetInsightSelectorsResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.GetInsightSelectorsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTInsightSelectorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrailName parameter. The -PassThru parameter is deprecated, use -Select '^TrailName' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CT.GetCTPublicKeyCmdlet"> <summary> Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key. <note><para> CloudTrail uses different private/public key pairs per region. Each digest file is signed with a private key unique to its region. Therefore, when you validate a digest file from a particular region, you must look in the same region for its corresponding public key. </para></note><br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTPublicKeyCmdlet.EndTime"> <summary> <para> <para>Optionally specifies, in UTC, the end of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTPublicKeyCmdlet.StartTime"> <summary> <para> <para>Optionally specifies, in UTC, the start of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used, and the current public key is returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTPublicKeyCmdlet.NextToken"> <summary> <para> <para>Reserved for future use.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTPublicKeyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PublicKeyList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudTrail.Model.ListPublicKeysResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.ListPublicKeysResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTPublicKeyCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CT.GetCTResourceTagCmdlet"> <summary> Lists the tags for the trail in the current region.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTResourceTagCmdlet.ResourceIdList"> <summary> <para> <para>Specifies a list of trail ARNs whose tags will be listed. The list has a limit of 20 ARNs. The format of a trail ARN is:</para><para><code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTResourceTagCmdlet.NextToken"> <summary> <para> <para>Reserved for future use.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourceTagList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudTrail.Model.ListTagsResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.ListTagsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTResourceTagCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CT.GetCTTrailCmdlet"> <summary> Retrieves settings for one or more trails associated with the current region for your account. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTTrailCmdlet.IncludeShadowTrail"> <summary> <para> <para>Specifies whether to include shadow trails in the response. A shadow trail is the replication in a region of a trail that was created in a different region, or in the case of an organization trail, the replication of an organization trail in member accounts. If you do not include shadow trails, organization trails in a member account and region replication trails will not be returned. The default is true.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTTrailCmdlet.TrailNameList"> <summary> <para> <para>Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is:</para><para><code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code></para><para>If an empty list is specified, information for the trail in the current region is returned.</para><ul><li><para>If an empty list is specified and <code>IncludeShadowTrails</code> is false, then information for all trails in the current region is returned.</para></li><li><para>If an empty list is specified and IncludeShadowTrails is null or true, then information for all trails in the current region and any associated shadow trails in other regions is returned.</para></li></ul><note><para>If one or more trail names are specified, information is returned only if the names match the names of trails belonging only to the current region. To return information about a trail in another region, you must specify its trail ARN.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTTrailCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TrailList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudTrail.Model.DescribeTrailsResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.DescribeTrailsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTTrailCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrailNameList parameter. The -PassThru parameter is deprecated, use -Select '^TrailNameList' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CT.GetCTTrailByNameCmdlet"> <summary> Returns settings information for a specified trail. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTTrailByNameCmdlet.Name"> <summary> <para> <para>The name or the Amazon Resource Name (ARN) of the trail for which you want to retrieve settings information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTTrailByNameCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Trail'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudTrail.Model.GetTrailResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.GetTrailResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTTrailByNameCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CT.GetCTTrailStatusCmdlet"> <summary> Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single region. To return trail status from all regions, you must call the operation on each region. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTTrailStatusCmdlet.Name"> <summary> <para> <para>Specifies the name or the CloudTrail ARN of the trail for which you are requesting status. To get the status of a shadow trail (a replication of the trail in another region), you must specify its ARN. The format of a trail ARN is:</para><para><code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTTrailStatusCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudTrail.Model.GetTrailStatusResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.GetTrailStatusResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTTrailStatusCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CT.GetCTTrailSummaryCmdlet"> <summary> Lists trails that are in the current account.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTTrailSummaryCmdlet.NextToken"> <summary> <para> <para>The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTTrailSummaryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Trails'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudTrail.Model.ListTrailsResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.ListTrailsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTTrailSummaryCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet"> <summary> Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.CloudWatchLogsLogGroupArn"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.CloudWatchLogsRoleArn"> <summary> <para> <para>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.EnableLogFileValidation"> <summary> <para> <para>Specifies whether log file integrity validation is enabled. The default is false.</para><note><para>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.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.IncludeGlobalServiceEvent"> <summary> <para> <para>Specifies whether the trail is publishing events from global services such as IAM to the log files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.IsMultiRegionTrail"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.IsOrganizationTrail"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.KmsKeyId"> <summary> <para> <para>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.</para><para>Examples:</para><ul><li><para>alias/MyAliasName</para></li><li><para>arn:aws:kms:us-east-2:123456789012:alias/MyAliasName</para></li><li><para>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</para></li><li><para>12345678-1234-1234-1234-123456789012</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.Name"> <summary> <para> <para>Specifies the name of the trail. The name must meet the following requirements:</para><ul><li><para>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</para></li><li><para>Start with a letter or number, and end with a letter or number</para></li><li><para>Be between 3 and 128 characters</para></li><li><para>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</para></li><li><para>Not be in IP address format (for example, 192.168.5.4)</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.S3BucketName"> <summary> <para> <para>Specifies the name of the Amazon S3 bucket designated for publishing log files. See <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html">Amazon S3 Bucket Naming Requirements</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.S3KeyPrefix"> <summary> <para> <para>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 <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html">Finding Your CloudTrail Log Files</a>. The maximum length is 200 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.SnsTopicName"> <summary> <para> <para>Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.TagsList"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudTrail.Model.CreateTrailResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.CreateTrailResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTTrailCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CT.RemoveCTResourceTagCmdlet"> <summary> Removes the specified tags from a trail. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTResourceTagCmdlet.ResourceId"> <summary> <para> <para>Specifies the ARN of the trail from which tags should be removed. The format of a trail ARN is:</para><para><code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTResourceTagCmdlet.TagsList"> <summary> <para> <para>Specifies a list of tags to be removed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudTrail.Model.RemoveTagsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceId parameter. The -PassThru parameter is deprecated, use -Select '^ResourceId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CT.RemoveCTTrailCmdlet"> <summary> Deletes a trail. This operation must be called from the region in which the trail was created. <code>DeleteTrail</code> cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTTrailCmdlet.Name"> <summary> <para> <para>Specifies the name or the CloudTrail ARN of the trail to be deleted. The format of a trail ARN is: <code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTTrailCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudTrail.Model.DeleteTrailResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTTrailCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTTrailCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CT.StartCTLoggingCmdlet"> <summary> Starts the recording of AWS API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StartCTLoggingCmdlet.Name"> <summary> <para> <para>Specifies the name or the CloudTrail ARN of the trail for which CloudTrail logs AWS API calls. The format of a trail ARN is:</para><para><code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StartCTLoggingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudTrail.Model.StartLoggingResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StartCTLoggingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StartCTLoggingCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CT.StopCTLoggingCmdlet"> <summary> Suspends the recording of AWS API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording. For a trail enabled in all regions, this operation must be called from the region in which the trail was created, or an <code>InvalidHomeRegionException</code> will occur. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail enabled in all regions. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StopCTLoggingCmdlet.Name"> <summary> <para> <para>Specifies the name or the CloudTrail ARN of the trail for which CloudTrail will stop logging AWS API calls. The format of a trail ARN is:</para><para><code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StopCTLoggingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudTrail.Model.StopLoggingResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StopCTLoggingCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StopCTLoggingCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet"> <summary> Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. <code>UpdateTrail</code> must be called from the region in which the trail was created; otherwise, an <code>InvalidHomeRegionException</code> is thrown. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.CloudWatchLogsLogGroupArn"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.CloudWatchLogsRoleArn"> <summary> <para> <para>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.EnableLogFileValidation"> <summary> <para> <para>Specifies whether log file validation is enabled. The default is false.</para><note><para>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.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.IncludeGlobalServiceEvent"> <summary> <para> <para>Specifies whether the trail is publishing events from global services such as IAM to the log files.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.IsMultiRegionTrail"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.IsOrganizationTrail"> <summary> <para> <para>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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.KmsKeyId"> <summary> <para> <para>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.</para><para>Examples:</para><ul><li><para>alias/MyAliasName</para></li><li><para>arn:aws:kms:us-east-2:123456789012:alias/MyAliasName</para></li><li><para>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</para></li><li><para>12345678-1234-1234-1234-123456789012</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.Name"> <summary> <para> <para>Specifies the name of the trail or trail ARN. If <code>Name</code> is a trail name, the string must meet the following requirements:</para><ul><li><para>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</para></li><li><para>Start with a letter or number, and end with a letter or number</para></li><li><para>Be between 3 and 128 characters</para></li><li><para>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</para></li><li><para>Not be in IP address format (for example, 192.168.5.4)</para></li></ul><para>If <code>Name</code> is a trail ARN, it must be in the format:</para><para><code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.S3BucketName"> <summary> <para> <para>Specifies the name of the Amazon S3 bucket designated for publishing log files. See <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html">Amazon S3 Bucket Naming Requirements</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.S3KeyPrefix"> <summary> <para> <para>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 <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html">Finding Your CloudTrail Log Files</a>. The maximum length is 200 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.SnsTopicName"> <summary> <para> <para>Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudTrail.Model.UpdateTrailResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.UpdateTrailResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTTrailCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CT.WriteCTEventSelectorCmdlet"> <summary> Configures an event selector or advanced event selectors for your trail. Use event selectors or advanced event selectors to specify management and data event settings for your trail. By default, trails created without specific event selectors are configured to log all read and write management events, and no data events. <para> When an event occurs in your account, CloudTrail evaluates the event selectors or advanced event selectors in 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. </para><para> Example </para><ol><li><para> You create an event selector for a trail and specify that you want write-only events. </para></li><li><para> The EC2 <code>GetConsoleOutput</code> and <code>RunInstances</code> API operations occur in your account. </para></li><li><para> CloudTrail evaluates whether the events match your event selectors. </para></li><li><para> The <code>RunInstances</code> is a write-only event and it matches your event selector. The trail logs the event. </para></li><li><para> The <code>GetConsoleOutput</code> is a read-only event that doesn't match your event selector. The trail doesn't log the event. </para></li></ol><para> The <code>PutEventSelectors</code> operation must be called from the region in which the trail was created; otherwise, an <code>InvalidHomeRegionException</code> exception is thrown. </para><para> You can configure up to five event selectors for each trail. For more information, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html">Logging data and management events for trails </a> and <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html">Quotas in AWS CloudTrail</a> in the <i>AWS CloudTrail User Guide</i>. </para><para> 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 <code>AdvancedEventSelectors</code> or <code>EventSelectors</code>, but not both. If you apply <code>AdvancedEventSelectors</code> to a trail, any existing <code>EventSelectors</code> are overwritten. For more information about advanced event selectors, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html">Logging data events for trails</a> in the <i>AWS CloudTrail User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.WriteCTEventSelectorCmdlet.AdvancedEventSelector"> <summary> <para> <para> Specifies the settings for advanced event selectors. 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 <code>AdvancedEventSelectors</code> or <code>EventSelectors</code>, but not both. If you apply <code>AdvancedEventSelectors</code> to a trail, any existing <code>EventSelectors</code> are overwritten. For more information about advanced event selectors, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html">Logging data events for trails</a> in the <i>AWS CloudTrail User Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.WriteCTEventSelectorCmdlet.EventSelector"> <summary> <para> <para>Specifies the settings for your event selectors. You can configure up to five event selectors for a trail. You can use either <code>EventSelectors</code> or <code>AdvancedEventSelectors</code> in a <code>PutEventSelectors</code> request, but not both. If you apply <code>EventSelectors</code> to a trail, any existing <code>AdvancedEventSelectors</code> are overwritten.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.WriteCTEventSelectorCmdlet.TrailName"> <summary> <para> <para>Specifies the name of the trail or trail ARN. If you specify a trail name, the string must meet the following requirements:</para><ul><li><para>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</para></li><li><para>Start with a letter or number, and end with a letter or number</para></li><li><para>Be between 3 and 128 characters</para></li><li><para>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</para></li><li><para>Not be in IP address format (for example, 192.168.5.4)</para></li></ul><para>If you specify a trail ARN, it must be in the format:</para><para><code>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.WriteCTEventSelectorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudTrail.Model.PutEventSelectorsResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.PutEventSelectorsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.WriteCTEventSelectorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrailName parameter. The -PassThru parameter is deprecated, use -Select '^TrailName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.WriteCTEventSelectorCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CT.WriteCTInsightSelectorCmdlet"> <summary> Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail. You also use <code>PutInsightSelectors</code> to turn off Insights event logging, by passing an empty list of insight types. In this release, only <code>ApiCallRateInsight</code> is supported as an Insights selector. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.WriteCTInsightSelectorCmdlet.InsightSelector"> <summary> <para> <para>A JSON string that contains the insight types you want to log on a trail. In this release, only <code>ApiCallRateInsight</code> is supported as an insight type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.WriteCTInsightSelectorCmdlet.TrailName"> <summary> <para> <para>The name of the CloudTrail trail for which you want to change or add Insights selectors.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.WriteCTInsightSelectorCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudTrail.Model.PutInsightSelectorsResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.PutInsightSelectorsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.WriteCTInsightSelectorCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrailName parameter. The -PassThru parameter is deprecated, use -Select '^TrailName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.WriteCTInsightSelectorCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |