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, event data store, or channel, 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; 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 or event data store that applies to all Amazon Web Services Regions only from the Region in which the trail or event data store 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, event data store, or channel to which one or more tags will be added.</para><para>The format of a trail ARN is: <c>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</c></para><para>The format of an event data store ARN is: <c>arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE</c></para><para>The format of a channel ARN is: <c>arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.AddCTResourceTagCmdlet.TagsList"> <summary> <para> <para>Contains a list of 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.DisableCTFederationCmdlet"> <summary> Disables Lake query federation on the specified event data store. When you disable federation, CloudTrail disables the integration with Glue, Lake Formation, and Amazon Athena. After disabling Lake query federation, you can no longer query your event data in Amazon Athena. <para> No CloudTrail Lake data is deleted when you disable federation and you can continue to run queries in CloudTrail Lake. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.DisableCTFederationCmdlet.EventDataStore"> <summary> <para> <para> The ARN (or ID suffix of the ARN) of the event data store for which you want to disable Lake query federation. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.DisableCTFederationCmdlet.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.DisableFederationResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.DisableFederationResponse 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.DisableCTFederationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EventDataStore parameter. The -PassThru parameter is deprecated, use -Select '^EventDataStore' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.DisableCTFederationCmdlet.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.EnableCTFederationCmdlet"> <summary> Enables Lake query federation on the specified event data store. Federating an event data store lets you view the metadata associated with the event data store in the Glue <a href="https://docs.aws.amazon.com/glue/latest/dg/components-overview.html#data-catalog-intro">Data Catalog</a> and run SQL queries against your event data using Amazon Athena. The table metadata stored in the Glue Data Catalog lets the Athena query engine know how to find, read, and process the data that you want to query. <para> When you enable Lake query federation, CloudTrail creates a managed database named <c>aws:cloudtrail</c> (if the database doesn't already exist) and a managed federated table in the Glue Data Catalog. The event data store ID is used for the table name. CloudTrail registers the role ARN and event data store in <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-federation-lake-formation.html">Lake Formation</a>, the service responsible for allowing fine-grained access control of the federated resources in the Glue Data Catalog. </para><para> For more information about Lake query federation, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-federation.html">Federate an event data store</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.EnableCTFederationCmdlet.EventDataStore"> <summary> <para> <para>The ARN (or ID suffix of the ARN) of the event data store for which you want to enable Lake query federation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.EnableCTFederationCmdlet.FederationRoleArn"> <summary> <para> <para> The ARN of the federation role to use for the event data store. Amazon Web Services services like Lake Formation use this federation role to access data for the federated event data store. The federation role must exist in your account and provide the <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-federation.html#query-federation-permissions-role">required minimum permissions</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.EnableCTFederationCmdlet.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.EnableFederationResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.EnableFederationResponse 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.EnableCTFederationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the FederationRoleArn parameter. The -PassThru parameter is deprecated, use -Select '^FederationRoleArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.EnableCTFederationCmdlet.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. <note><para><c>LookupEvents</c> returns recent Insights events for trails that enable Insights. To view Insights events for an event data store, you can run queries on your Insights event data store, and you can also view the Lake dashboard for Insights. </para></note><para> Lookup supports the following attributes for management events: </para><ul><li><para> Amazon Web Services 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 <c>insight</c> as the value of <c>EventCategory</c>, 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 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.GetCTChannelCmdlet"> <summary> Returns information about a specific channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTChannelCmdlet.Channel"> <summary> <para> <para>The ARN or <c>UUID</c> of a channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTChannelCmdlet.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.GetChannelResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.GetChannelResponse 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.GetCTChannelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Channel parameter. The -PassThru parameter is deprecated, use -Select '^Channel' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CT.GetCTChannelSummaryCmdlet"> <summary> Lists the channels in the current account, and their source names.<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.GetCTChannelSummaryCmdlet.MaxResult"> <summary> <para> <para> The maximum number of CloudTrail channels to display on a single page. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTChannelSummaryCmdlet.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 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.GetCTChannelSummaryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Channels'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudTrail.Model.ListChannelsResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.ListChannelsResponse 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.GetCTChannelSummaryCmdlet.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.GetCTEventDataStoreCmdlet"> <summary> Returns information about an event data store specified as either an ARN or the ID portion of the ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTEventDataStoreCmdlet.EventDataStore"> <summary> <para> <para>The ARN (or ID suffix of the ARN) of the event data store about which you want information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTEventDataStoreCmdlet.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.GetEventDataStoreResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.GetEventDataStoreResponse 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.GetCTEventDataStoreCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EventDataStore parameter. The -PassThru parameter is deprecated, use -Select '^EventDataStore' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CT.GetCTEventDataStoreSummaryCmdlet"> <summary> Returns information about all event data stores in the account, 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.GetCTEventDataStoreSummaryCmdlet.MaxResult"> <summary> <para> <para>The maximum number of event data stores to display on a single page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTEventDataStoreSummaryCmdlet.NextToken"> <summary> <para> <para>A token you can use to get the next page of event data store results.</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.GetCTEventDataStoreSummaryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EventDataStores'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudTrail.Model.ListEventDataStoresResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.ListEventDataStoresResponse 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.GetCTEventDataStoreSummaryCmdlet.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 resources on which you are logging data events. </para></li></ul><para> For more information about logging management and data events, see the following topics in the <i>CloudTrail User Guide</i>: </para><ul><li><para><a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-events-with-cloudtrail.html">Logging management events</a></para></li><li><para><a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html">Logging data events</a></para></li></ul> </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 <c>my-_namespace</c> and <c>my--namespace</c> 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><c>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</c></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.GetCTImportCmdlet"> <summary> Returns information about a specific import. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTImportCmdlet.ImportId"> <summary> <para> <para> The ID for the import. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTImportCmdlet.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.GetImportResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.GetImportResponse 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.GetCTImportCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ImportId parameter. The -PassThru parameter is deprecated, use -Select '^ImportId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CT.GetCTImportFailureCmdlet"> <summary> Returns a list of failures for the specified import.<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.GetCTImportFailureCmdlet.ImportId"> <summary> <para> <para> The ID of the import. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTImportFailureCmdlet.MaxResult"> <summary> <para> <para> The maximum number of failures to display on a single page. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTImportFailureCmdlet.NextToken"> <summary> <para> <para> A token you can use to get the next page of import failures. </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.GetCTImportFailureCmdlet.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.ListImportFailuresResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.ListImportFailuresResponse 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.GetCTImportFailureCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ImportId parameter. The -PassThru parameter is deprecated, use -Select '^ImportId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTImportFailureCmdlet.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.GetCTImportListCmdlet"> <summary> Returns information on all imports, or a select set of imports by <c>ImportStatus</c> or <c>Destination</c>.<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.GetCTImportListCmdlet.Destination"> <summary> <para> <para> The ARN of the destination event data store. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTImportListCmdlet.ImportStatus"> <summary> <para> <para> The status of the import. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTImportListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of imports to display on a single page. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTImportListCmdlet.NextToken"> <summary> <para> <para> A token you can use to get the next page of import results. </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.GetCTImportListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Imports'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudTrail.Model.ListImportsResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.ListImportsResponse 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.GetCTImportListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Destination parameter. The -PassThru parameter is deprecated, use -Select '^Destination' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTImportListCmdlet.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.GetCTInsightSelectorCmdlet"> <summary> Describes the settings for the Insights event selectors that you configured for your trail or event data store. <c>GetInsightSelectors</c> shows if CloudTrail Insights event logging is enabled on the trail or event data store, and if it is, which Insights types are enabled. If you run <c>GetInsightSelectors</c> on a trail or event data store that does not have Insights events enabled, the operation throws the exception <c>InsightNotEnabledException</c><para> Specify either the <c>EventDataStore</c> parameter to get Insights event selectors for an event data store, or the <c>TrailName</c> parameter to the get Insights event selectors for a trail. You cannot specify these parameters together. </para><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</a> in the <i>CloudTrail User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTInsightSelectorCmdlet.EventDataStore"> <summary> <para> <para> Specifies the ARN (or ID suffix of the ARN) of the event data store for which you want to get Insights selectors. </para><para>You cannot use this parameter with the <c>TrailName</c> parameter.</para> </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 <c>my-_namespace</c> and <c>my--namespace</c> 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><c>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</c></para><para>You cannot use this parameter with the <c>EventDataStore</c> parameter.</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.GetCTInsightsMetricDataCmdlet"> <summary> Returns Insights metrics data for trails that have enabled Insights. The request must include the <c>EventSource</c>, <c>EventName</c>, and <c>InsightType</c> parameters. <para> If the <c>InsightType</c> is set to <c>ApiErrorRateInsight</c>, the request must also include the <c>ErrorCode</c> parameter. </para><para> The following are the available time periods for <c>ListInsightsMetricData</c>. Each cutoff is inclusive. </para><ul><li><para> Data points with a period of 60 seconds (1-minute) are available for 15 days. </para></li><li><para> Data points with a period of 300 seconds (5-minute) are available for 63 days. </para></li><li><para> Data points with a period of 3600 seconds (1 hour) are available for 90 days. </para></li></ul><para> Access to the <c>ListInsightsMetricData</c> API operation is linked to the <c>cloudtrail:LookupEvents</c> action. To use this operation, you must have permissions to perform the <c>cloudtrail:LookupEvents</c> action. </para><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.GetCTInsightsMetricDataCmdlet.DataType"> <summary> <para> <para>Type of datapoints to return. Valid values are <c>NonZeroData</c> and <c>FillWithZeros</c>. The default is <c>NonZeroData</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTInsightsMetricDataCmdlet.EndTime"> <summary> <para> <para>Specifies, in UTC, the end time for time-series data. The value specified is exclusive; results include data points up to the specified time stamp.</para><para>The default is the time of request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTInsightsMetricDataCmdlet.ErrorCode"> <summary> <para> <para>Conditionally required if the <c>InsightType</c> parameter is set to <c>ApiErrorRateInsight</c>.</para><para>If returning metrics for the <c>ApiErrorRateInsight</c> Insights type, this is the error to retrieve data for. For example, <c>AccessDenied</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTInsightsMetricDataCmdlet.EventName"> <summary> <para> <para>The name of the event, typically the Amazon Web Services API on which unusual levels of activity were recorded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTInsightsMetricDataCmdlet.EventSource"> <summary> <para> <para>The Amazon Web Services service to which the request was made, such as <c>iam.amazonaws.com</c> or <c>s3.amazonaws.com</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTInsightsMetricDataCmdlet.InsightType"> <summary> <para> <para>The type of CloudTrail Insights event, which is either <c>ApiCallRateInsight</c> or <c>ApiErrorRateInsight</c>. The <c>ApiCallRateInsight</c> Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume. The <c>ApiErrorRateInsight</c> Insights type analyzes management API calls that result in error codes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTInsightsMetricDataCmdlet.Period"> <summary> <para> <para>Granularity of data to retrieve, in seconds. Valid values are <c>60</c>, <c>300</c>, and <c>3600</c>. If you specify any other value, you will get an error. The default is 3600 seconds.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTInsightsMetricDataCmdlet.StartTime"> <summary> <para> <para>Specifies, in UTC, the start time for time-series data. The value specified is inclusive; results include data points with the specified time stamp.</para><para>The default is 90 days before the time of request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTInsightsMetricDataCmdlet.MaxResult"> <summary> <para> <para>The maximum number of datapoints to return. Valid values are integers from 1 to 21600. The default value is 21600.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTInsightsMetricDataCmdlet.NextToken"> <summary> <para> <para>Returned if all datapoints can't be returned in a single call. For example, due to reaching <c>MaxResults</c>.</para><para>Add this parameter to the request to continue retrieving results starting from the last evaluated point.</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.GetCTInsightsMetricDataCmdlet.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.ListInsightsMetricDataResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.ListInsightsMetricDataResponse 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.GetCTInsightsMetricDataCmdlet.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.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 and public key pairs per Region. Each digest file is signed with a private key unique to its Region. When you validate a digest file from a specific 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.GetCTQueryCmdlet"> <summary> Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query status. If the query results were delivered to an S3 bucket, the response also provides the S3 URI and the delivery status. <para> You must specify either a <c>QueryID</c> or a <c>QueryAlias</c>. Specifying the <c>QueryAlias</c> parameter returns information about the last query run for the alias. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTQueryCmdlet.QueryAlias"> <summary> <para> <para> The alias that identifies a query template. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTQueryCmdlet.QueryId"> <summary> <para> <para>The query ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTQueryCmdlet.EventDataStore"> <summary> <para> <para>The ARN (or the ID suffix of the ARN) of an event data store on which the specified query was run.</para> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTQueryCmdlet.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.DescribeQueryResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.DescribeQueryResponse 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.GetCTQueryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryId parameter. The -PassThru parameter is deprecated, use -Select '^QueryId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CT.GetCTQueryResultCmdlet"> <summary> Gets event data results of a query. You must specify the <c>QueryID</c> value returned by the <c>StartQuery</c> operation.<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.GetCTQueryResultCmdlet.MaxQueryResult"> <summary> <para> <para>The maximum number of query results to display on a single page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTQueryResultCmdlet.QueryId"> <summary> <para> <para>The ID of the query for which you want to get results.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTQueryResultCmdlet.EventDataStore"> <summary> <para> <para>The ARN (or ID suffix of the ARN) of the event data store against which the query was run.</para> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTQueryResultCmdlet.NextToken"> <summary> <para> <para>A token you can use to get the next page of query results.</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.GetCTQueryResultCmdlet.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.GetQueryResultsResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.GetQueryResultsResponse 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.GetCTQueryResultCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryId parameter. The -PassThru parameter is deprecated, use -Select '^QueryId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTQueryResultCmdlet.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.GetCTQuerySummaryCmdlet"> <summary> Returns a list of queries and query statuses for the past seven days. You must specify an ARN value for <c>EventDataStore</c>. Optionally, to shorten the list of results, you can specify a time range, formatted as timestamps, by adding <c>StartTime</c> and <c>EndTime</c> parameters, and a <c>QueryStatus</c> value. Valid values for <c>QueryStatus</c> include <c>QUEUED</c>, <c>RUNNING</c>, <c>FINISHED</c>, <c>FAILED</c>, <c>TIMED_OUT</c>, or <c>CANCELLED</c>.<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.GetCTQuerySummaryCmdlet.EndTime"> <summary> <para> <para>Use with <c>StartTime</c> to bound a <c>ListQueries</c> request, and limit its results to only those queries run within a specified time period.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTQuerySummaryCmdlet.EventDataStore"> <summary> <para> <para>The ARN (or the ID suffix of the ARN) of an event data store on which queries were run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTQuerySummaryCmdlet.QueryStatus"> <summary> <para> <para>The status of queries that you want to return in results. Valid values for <c>QueryStatus</c> include <c>QUEUED</c>, <c>RUNNING</c>, <c>FINISHED</c>, <c>FAILED</c>, <c>TIMED_OUT</c>, or <c>CANCELLED</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTQuerySummaryCmdlet.StartTime"> <summary> <para> <para>Use with <c>EndTime</c> to bound a <c>ListQueries</c> request, and limit its results to only those queries run within a specified time period.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTQuerySummaryCmdlet.MaxResult"> <summary> <para> <para>The maximum number of queries to show on a page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTQuerySummaryCmdlet.NextToken"> <summary> <para> <para>A token you can use to get the next page of results.</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.GetCTQuerySummaryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Queries'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudTrail.Model.ListQueriesResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.ListQueriesResponse 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.GetCTQuerySummaryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EventDataStore parameter. The -PassThru parameter is deprecated, use -Select '^EventDataStore' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTQuerySummaryCmdlet.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.GetCTResourcePolicyCmdlet"> <summary> Retrieves the JSON text of the resource-based policy document attached to the CloudTrail channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTResourcePolicyCmdlet.ResourceArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the CloudTrail channel attached to the resource-based policy. The following is the format of a resource ARN: <c>arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.GetCTResourcePolicyCmdlet.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.GetResourcePolicyResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.GetResourcePolicyResponse 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.GetCTResourcePolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CT.GetCTResourceTagCmdlet"> <summary> Lists the tags for the specified trails, event data stores, or channels 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, event data store, or channel ARNs whose tags will be listed. The list has a limit of 20 ARNs.</para><para> Example trail ARN format: <c>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</c></para><para>Example event data store ARN format: <c>arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE</c></para><para>Example channel ARN format: <c>arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890</c></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><c>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</c></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 <c>IncludeShadowTrails</c> 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 and current account. 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 following is the format of a trail ARN.</para><para><c>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</c></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 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.NewCTChannelCmdlet"> <summary> Creates a channel for CloudTrail to ingest events from a partner or external source. After you create a channel, a CloudTrail Lake event data store can log events from the partner or source that you specify. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTChannelCmdlet.Destination"> <summary> <para> <para>One or more event data stores to which events arriving through a channel will be logged.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTChannelCmdlet.Name"> <summary> <para> <para>The name of the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTChannelCmdlet.Source"> <summary> <para> <para>The name of the partner or external event source. You cannot change this name after you create the channel. A maximum of one channel is allowed per source.</para><para> A source can be either <c>Custom</c> for all valid non-Amazon Web Services events, or the name of a partner event source. For information about the source names for available partners, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/query-event-data-store-integration.html#cloudtrail-lake-partner-information">Additional information about integration partners</a> in the CloudTrail User Guide. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTChannelCmdlet.Tag"> <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.NewCTChannelCmdlet.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.CreateChannelResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.CreateChannelResponse 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.NewCTChannelCmdlet.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.NewCTChannelCmdlet.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.NewCTEventDataStoreCmdlet"> <summary> Creates a new event data store. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTEventDataStoreCmdlet.AdvancedEventSelector"> <summary> <para> <para>The advanced event selectors to use to select the events for the data store. You can configure up to five advanced event selectors for each event data store.</para><para> For more information about how to use advanced event selectors to log CloudTrail events, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html#creating-data-event-selectors-advanced">Log events by using advanced event selectors</a> in the CloudTrail User Guide.</para><para>For more information about how to use advanced event selectors to include Config configuration items in your event data store, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/lake-eds-cli.html#lake-cli-create-eds-config">Create an event data store for Config configuration items</a> in the CloudTrail User Guide.</para><para>For more information about how to use advanced event selectors to include events outside of Amazon Web Services events in your event data store, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/lake-integrations-cli.html#lake-cli-create-integration">Create an integration to log events from outside Amazon Web Services</a> in the CloudTrail User Guide.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTEventDataStoreCmdlet.BillingMode"> <summary> <para> <para>The billing mode for the event data store determines the cost for ingesting events and the default and maximum retention period for the event data store.</para><para>The following are the possible values:</para><ul><li><para><c>EXTENDABLE_RETENTION_PRICING</c> - This billing mode is generally recommended if you want a flexible retention period of up to 3653 days (about 10 years). The default retention period for this billing mode is 366 days.</para></li><li><para><c>FIXED_RETENTION_PRICING</c> - This billing mode is recommended if you expect to ingest more than 25 TB of event data per month and need a retention period of up to 2557 days (about 7 years). The default retention period for this billing mode is 2557 days.</para></li></ul><para>The default value is <c>EXTENDABLE_RETENTION_PRICING</c>.</para><para>For more information about CloudTrail pricing, see <a href="http://aws.amazon.com/cloudtrail/pricing/">CloudTrail Pricing</a> and <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-lake-manage-costs.html">Managing CloudTrail Lake costs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTEventDataStoreCmdlet.KmsKeyId"> <summary> <para> <para>Specifies the KMS key ID to use to encrypt the events delivered by CloudTrail. The value can be an alias name prefixed by <c>alias/</c>, a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.</para><important><para>Disabling or deleting the KMS key, or removing CloudTrail permissions on the key, prevents CloudTrail from logging events to the event data store, and prevents users from querying the data in the event data store that was encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you disable or delete a KMS key that you are using with an event data store, delete or back up your event data store.</para></important><para>CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Using multi-Region keys</a> in the <i>Key Management Service Developer Guide</i>.</para><para>Examples:</para><ul><li><para><c>alias/MyAliasName</c></para></li><li><para><c>arn:aws:kms:us-east-2:123456789012:alias/MyAliasName</c></para></li><li><para><c>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</c></para></li><li><para><c>12345678-1234-1234-1234-123456789012</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTEventDataStoreCmdlet.MultiRegionEnabled"> <summary> <para> <para>Specifies whether the event data store includes events from all Regions, or only from the Region in which the event data store is created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTEventDataStoreCmdlet.Name"> <summary> <para> <para>The name of the event data store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTEventDataStoreCmdlet.OrganizationEnabled"> <summary> <para> <para>Specifies whether an event data store collects events logged for an organization in Organizations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTEventDataStoreCmdlet.RetentionPeriod"> <summary> <para> <para>The retention period of the event data store, in days. If <c>BillingMode</c> is set to <c>EXTENDABLE_RETENTION_PRICING</c>, you can set a retention period of up to 3653 days, the equivalent of 10 years. If <c>BillingMode</c> is set to <c>FIXED_RETENTION_PRICING</c>, you can set a retention period of up to 2557 days, the equivalent of seven years.</para><para>CloudTrail Lake determines whether to retain an event by checking if the <c>eventTime</c> of the event is within the specified retention period. For example, if you set a retention period of 90 days, CloudTrail will remove events when the <c>eventTime</c> is older than 90 days.</para><note><para>If you plan to copy trail events to this event data store, we recommend that you consider both the age of the events that you want to copy as well as how long you want to keep the copied events in your event data store. For example, if you copy trail events that are 5 years old and specify a retention period of 7 years, the event data store will retain those events for two years.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTEventDataStoreCmdlet.StartIngestion"> <summary> <para> <para>Specifies whether the event data store should start ingesting live events. The default is true.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTEventDataStoreCmdlet.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.NewCTEventDataStoreCmdlet.TerminationProtectionEnabled"> <summary> <para> <para>Specifies whether termination protection is enabled for the event data store. If termination protection is enabled, you cannot delete the event data store until termination protection is disabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.NewCTEventDataStoreCmdlet.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.CreateEventDataStoreResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.CreateEventDataStoreResponse 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.NewCTEventDataStoreCmdlet.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.NewCTEventDataStoreCmdlet.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.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. You must use a log group that exists in your account.</para><para>Not required unless you specify <c>CloudWatchLogsRoleArn</c>.</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. You must use a role that exists in your account.</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 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.</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 Organizations, or only for the current Amazon Web Services account. The default is false, and cannot be true unless the call is made on behalf of an Amazon Web Services account that is the management account or delegated administrator account for an organization in 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 <c>alias/</c>, a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.</para><para>CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Using multi-Region keys</a> in the <i>Key Management Service Developer Guide</i>.</para><para>Examples:</para><ul><li><para><c>alias/MyAliasName</c></para></li><li><para><c>arn:aws:kms:us-east-2:123456789012:alias/MyAliasName</c></para></li><li><para><c>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</c></para></li><li><para><c>12345678-1234-1234-1234-123456789012</c></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 <c>my-_namespace</c> and <c>my--namespace</c> are not valid.</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. For information about bucket naming rules, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html">Bucket naming rules</a> in the <i>Amazon Simple Storage Service User Guide</i>. </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/get-and-view-cloudtrail-log-files.html#cloudtrail-find-log-files">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.RegisterCTOrganizationDelegatedAdminCmdlet"> <summary> Registers an organization’s member account as the CloudTrail <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-delegated-administrator.html">delegated administrator</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RegisterCTOrganizationDelegatedAdminCmdlet.MemberAccountId"> <summary> <para> <para>An organization member account ID that you want to designate as a delegated administrator.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RegisterCTOrganizationDelegatedAdminCmdlet.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.RegisterOrganizationDelegatedAdminResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RegisterCTOrganizationDelegatedAdminCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the MemberAccountId parameter. The -PassThru parameter is deprecated, use -Select '^MemberAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RegisterCTOrganizationDelegatedAdminCmdlet.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.RemoveCTChannelCmdlet"> <summary> Deletes a channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTChannelCmdlet.Channel"> <summary> <para> <para>The ARN or the <c>UUID</c> value of the channel that you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTChannelCmdlet.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.DeleteChannelResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTChannelCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Channel parameter. The -PassThru parameter is deprecated, use -Select '^Channel' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTChannelCmdlet.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.RemoveCTEventDataStoreCmdlet"> <summary> Disables the event data store specified by <c>EventDataStore</c>, which accepts an event data store ARN. After you run <c>DeleteEventDataStore</c>, the event data store enters a <c>PENDING_DELETION</c> state, and is automatically deleted after a wait period of seven days. <c>TerminationProtectionEnabled</c> must be set to <c>False</c> on the event data store and the <c>FederationStatus</c> must be <c>DISABLED</c>. You cannot delete an event data store if <c>TerminationProtectionEnabled</c> is <c>True</c> or the <c>FederationStatus</c> is <c>ENABLED</c>. <para> After you run <c>DeleteEventDataStore</c> on an event data store, you cannot run <c>ListQueries</c>, <c>DescribeQuery</c>, or <c>GetQueryResults</c> on queries that are using an event data store in a <c>PENDING_DELETION</c> state. An event data store in the <c>PENDING_DELETION</c> state does not incur costs. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTEventDataStoreCmdlet.EventDataStore"> <summary> <para> <para>The ARN (or the ID suffix of the ARN) of the event data store to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTEventDataStoreCmdlet.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.DeleteEventDataStoreResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTEventDataStoreCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EventDataStore parameter. The -PassThru parameter is deprecated, use -Select '^EventDataStore' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTEventDataStoreCmdlet.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.RemoveCTResourcePolicyCmdlet"> <summary> Deletes the resource-based policy attached to the CloudTrail channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTResourcePolicyCmdlet.ResourceArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the CloudTrail channel you're deleting the resource-based policy from. The following is the format of a resource ARN: <c>arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTResourcePolicyCmdlet.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.DeleteResourcePolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTResourcePolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTResourcePolicyCmdlet.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, event data store, or channel. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RemoveCTResourceTagCmdlet.ResourceId"> <summary> <para> <para>Specifies the ARN of the trail, event data store, or channel from which tags should be removed.</para><para> Example trail ARN format: <c>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</c></para><para>Example event data store ARN format: <c>arn:aws:cloudtrail:us-east-2:123456789012:eventdatastore/EXAMPLE-f852-4e8f-8bd1-bcf6cEXAMPLE</c></para><para>Example channel ARN format: <c>arn:aws:cloudtrail:us-east-2:123456789012:channel/01234567890</c></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. <c>DeleteTrail</c> 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 following is the format of a trail ARN. <c>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</c></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.RestoreCTEventDataStoreCmdlet"> <summary> Restores a deleted event data store specified by <c>EventDataStore</c>, which accepts an event data store ARN. You can only restore a deleted event data store within the seven-day wait period after deletion. Restoring an event data store can take several minutes, depending on the size of the event data store. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RestoreCTEventDataStoreCmdlet.EventDataStore"> <summary> <para> <para>The ARN (or the ID suffix of the ARN) of the event data store that you want to restore.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RestoreCTEventDataStoreCmdlet.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.RestoreEventDataStoreResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.RestoreEventDataStoreResponse 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.RestoreCTEventDataStoreCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EventDataStore parameter. The -PassThru parameter is deprecated, use -Select '^EventDataStore' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.RestoreCTEventDataStoreCmdlet.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.StartCTEventDataStoreIngestionCmdlet"> <summary> Starts the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To start ingestion, the event data store <c>Status</c> must be <c>STOPPED_INGESTION</c> and the <c>eventCategory</c> must be <c>Management</c>, <c>Data</c>, or <c>ConfigurationItem</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StartCTEventDataStoreIngestionCmdlet.EventDataStore"> <summary> <para> <para>The ARN (or ID suffix of the ARN) of the event data store for which you want to start ingestion.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StartCTEventDataStoreIngestionCmdlet.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.StartEventDataStoreIngestionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StartCTEventDataStoreIngestionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EventDataStore parameter. The -PassThru parameter is deprecated, use -Select '^EventDataStore' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StartCTEventDataStoreIngestionCmdlet.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.StartCTImportCmdlet"> <summary> Starts an import of logged trail events from a source S3 bucket to a destination event data store. By default, CloudTrail only imports events contained in the S3 bucket's <c>CloudTrail</c> prefix and the prefixes inside the <c>CloudTrail</c> prefix, and does not check prefixes for other Amazon Web Services services. If you want to import CloudTrail events contained in another prefix, you must include the prefix in the <c>S3LocationUri</c>. For more considerations about importing trail events, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-copy-trail-to-lake.html#cloudtrail-trail-copy-considerations">Considerations for copying trail events</a> in the <i>CloudTrail User Guide</i>. <para> When you start a new import, the <c>Destinations</c> and <c>ImportSource</c> parameters are required. Before starting a new import, disable any access control lists (ACLs) attached to the source S3 bucket. For more information about disabling ACLs, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling ownership of objects and disabling ACLs for your bucket</a>. </para><para> When you retry an import, the <c>ImportID</c> parameter is required. </para><note><para> If the destination event data store is for an organization, you must use the management account to import trail events. You cannot use the delegated administrator account for the organization. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StartCTImportCmdlet.Destination"> <summary> <para> <para> The ARN of the destination event data store. Use this parameter for a new import. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StartCTImportCmdlet.EndEventTime"> <summary> <para> <para> Use with <c>StartEventTime</c> to bound a <c>StartImport</c> request, and limit imported trail events to only those events logged within a specified time period. When you specify a time range, CloudTrail checks the prefix and log file names to verify the names contain a date between the specified <c>StartEventTime</c> and <c>EndEventTime</c> before attempting to import events. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StartCTImportCmdlet.ImportId"> <summary> <para> <para> The ID of the import. Use this parameter when you are retrying an import. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StartCTImportCmdlet.S3_S3BucketAccessRoleArn"> <summary> <para> <para> The IAM ARN role used to access the source S3 bucket. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StartCTImportCmdlet.S3_S3BucketRegion"> <summary> <para> <para> The Region associated with the source S3 bucket. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StartCTImportCmdlet.S3_S3LocationUri"> <summary> <para> <para> The URI for the source S3 bucket. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StartCTImportCmdlet.StartEventTime"> <summary> <para> <para> Use with <c>EndEventTime</c> to bound a <c>StartImport</c> request, and limit imported trail events to only those events logged within a specified time period. When you specify a time range, CloudTrail checks the prefix and log file names to verify the names contain a date between the specified <c>StartEventTime</c> and <c>EndEventTime</c> before attempting to import events. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StartCTImportCmdlet.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.StartImportResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.StartImportResponse 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.StartCTImportCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Destination parameter. The -PassThru parameter is deprecated, use -Select '^Destination' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StartCTImportCmdlet.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 Amazon Web Services 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 Amazon Web Services API calls. The following is the format of a trail ARN.</para><para><c>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</c></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.StartCTQueryCmdlet"> <summary> Starts a CloudTrail Lake query. Use the <c>QueryStatement</c> parameter to provide your SQL query, enclosed in single quotation marks. Use the optional <c>DeliveryS3Uri</c> parameter to deliver the query results to an S3 bucket. <para><c>StartQuery</c> requires you specify either the <c>QueryStatement</c> parameter, or a <c>QueryAlias</c> and any <c>QueryParameters</c>. In the current release, the <c>QueryAlias</c> and <c>QueryParameters</c> parameters are used only for the queries that populate the CloudTrail Lake dashboards. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StartCTQueryCmdlet.DeliveryS3Uri"> <summary> <para> <para> The URI for the S3 bucket where CloudTrail delivers the query results. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StartCTQueryCmdlet.QueryAlias"> <summary> <para> <para> The alias that identifies a query template. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StartCTQueryCmdlet.QueryParameter"> <summary> <para> <para> The query parameters for the specified <c>QueryAlias</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StartCTQueryCmdlet.QueryStatement"> <summary> <para> <para>The SQL code of your query.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StartCTQueryCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'QueryId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CloudTrail.Model.StartQueryResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.StartQueryResponse 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.StartCTQueryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryStatement parameter. The -PassThru parameter is deprecated, use -Select '^QueryStatement' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StartCTQueryCmdlet.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.StopCTEventDataStoreIngestionCmdlet"> <summary> Stops the ingestion of live events on an event data store specified as either an ARN or the ID portion of the ARN. To stop ingestion, the event data store <c>Status</c> must be <c>ENABLED</c> and the <c>eventCategory</c> must be <c>Management</c>, <c>Data</c>, or <c>ConfigurationItem</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StopCTEventDataStoreIngestionCmdlet.EventDataStore"> <summary> <para> <para>The ARN (or ID suffix of the ARN) of the event data store for which you want to stop ingestion.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StopCTEventDataStoreIngestionCmdlet.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.StopEventDataStoreIngestionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StopCTEventDataStoreIngestionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EventDataStore parameter. The -PassThru parameter is deprecated, use -Select '^EventDataStore' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StopCTEventDataStoreIngestionCmdlet.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.StopCTImportCmdlet"> <summary> Stops a specified import. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StopCTImportCmdlet.ImportId"> <summary> <para> <para> The ID of the import. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StopCTImportCmdlet.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.StopImportResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.StopImportResponse 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.StopCTImportCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ImportId parameter. The -PassThru parameter is deprecated, use -Select '^ImportId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StopCTImportCmdlet.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 Amazon Web Services 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 <c>InvalidHomeRegionException</c> 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 Amazon Web Services API calls. The following is the format of a trail ARN.</para><para><c>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</c></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.StopCTQueryCmdlet"> <summary> Cancels a query if the query is not in a terminated state, such as <c>CANCELLED</c>, <c>FAILED</c>, <c>TIMED_OUT</c>, or <c>FINISHED</c>. You must specify an ARN value for <c>EventDataStore</c>. The ID of the query that you want to cancel is also required. When you run <c>CancelQuery</c>, the query status might show as <c>CANCELLED</c> even if the operation is not yet finished. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StopCTQueryCmdlet.QueryId"> <summary> <para> <para>The ID of the query that you want to cancel. The <c>QueryId</c> comes from the response of a <c>StartQuery</c> operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StopCTQueryCmdlet.EventDataStore"> <summary> <para> <para>The ARN (or the ID suffix of the ARN) of an event data store on which the specified query is running.</para> </para> <para>This parameter is deprecated.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StopCTQueryCmdlet.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.CancelQueryResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.CancelQueryResponse 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.StopCTQueryCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the QueryId parameter. The -PassThru parameter is deprecated, use -Select '^QueryId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.StopCTQueryCmdlet.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.UnregisterCTOrganizationDelegatedAdminCmdlet"> <summary> Removes CloudTrail delegated administrator permissions from a member account in an organization. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UnregisterCTOrganizationDelegatedAdminCmdlet.DelegatedAdminAccountId"> <summary> <para> <para>A delegated administrator account ID. This is a member account in an organization that is currently designated as a delegated administrator.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UnregisterCTOrganizationDelegatedAdminCmdlet.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.DeregisterOrganizationDelegatedAdminResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UnregisterCTOrganizationDelegatedAdminCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DelegatedAdminAccountId parameter. The -PassThru parameter is deprecated, use -Select '^DelegatedAdminAccountId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UnregisterCTOrganizationDelegatedAdminCmdlet.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.UpdateCTChannelCmdlet"> <summary> Updates a channel specified by a required channel ARN or UUID. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTChannelCmdlet.Channel"> <summary> <para> <para>The ARN or ID (the ARN suffix) of the channel that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTChannelCmdlet.Destination"> <summary> <para> <para>The ARNs of event data stores that you want to log events arriving through the channel.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTChannelCmdlet.Name"> <summary> <para> <para> Changes the name of the channel. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTChannelCmdlet.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.UpdateChannelResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.UpdateChannelResponse 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.UpdateCTChannelCmdlet.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.UpdateCTChannelCmdlet.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.UpdateCTEventDataStoreCmdlet"> <summary> Updates an event data store. The required <c>EventDataStore</c> value is an ARN or the ID portion of the ARN. Other parameters are optional, but at least one optional parameter must be specified, or CloudTrail throws an error. <c>RetentionPeriod</c> is in days, and valid values are integers between 7 and 3653 if the <c>BillingMode</c> is set to <c>EXTENDABLE_RETENTION_PRICING</c>, or between 7 and 2557 if <c>BillingMode</c> is set to <c>FIXED_RETENTION_PRICING</c>. By default, <c>TerminationProtection</c> is enabled. <para> For event data stores for CloudTrail events, <c>AdvancedEventSelectors</c> includes or excludes management or data events in your event data store. For more information about <c>AdvancedEventSelectors</c>, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/APIReference/API_AdvancedEventSelector.html">AdvancedEventSelectors</a>. </para><para> For event data stores for CloudTrail Insights events, Config configuration items, Audit Manager evidence, or non-Amazon Web Services events, <c>AdvancedEventSelectors</c> includes events of that type in your event data store. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTEventDataStoreCmdlet.AdvancedEventSelector"> <summary> <para> <para>The advanced event selectors used to select events for the event data store. You can configure up to five advanced event selectors for each event data store.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTEventDataStoreCmdlet.BillingMode"> <summary> <para> <note><para>You can't change the billing mode from <c>EXTENDABLE_RETENTION_PRICING</c> to <c>FIXED_RETENTION_PRICING</c>. If <c>BillingMode</c> is set to <c>EXTENDABLE_RETENTION_PRICING</c> and you want to use <c>FIXED_RETENTION_PRICING</c> instead, you'll need to stop ingestion on the event data store and create a new event data store that uses <c>FIXED_RETENTION_PRICING</c>.</para></note><para>The billing mode for the event data store determines the cost for ingesting events and the default and maximum retention period for the event data store.</para><para>The following are the possible values:</para><ul><li><para><c>EXTENDABLE_RETENTION_PRICING</c> - This billing mode is generally recommended if you want a flexible retention period of up to 3653 days (about 10 years). The default retention period for this billing mode is 366 days.</para></li><li><para><c>FIXED_RETENTION_PRICING</c> - This billing mode is recommended if you expect to ingest more than 25 TB of event data per month and need a retention period of up to 2557 days (about 7 years). The default retention period for this billing mode is 2557 days.</para></li></ul><para>For more information about CloudTrail pricing, see <a href="http://aws.amazon.com/cloudtrail/pricing/">CloudTrail Pricing</a> and <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-lake-manage-costs.html">Managing CloudTrail Lake costs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTEventDataStoreCmdlet.EventDataStore"> <summary> <para> <para>The ARN (or the ID suffix of the ARN) of the event data store that you want to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTEventDataStoreCmdlet.KmsKeyId"> <summary> <para> <para>Specifies the KMS key ID to use to encrypt the events delivered by CloudTrail. The value can be an alias name prefixed by <c>alias/</c>, a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.</para><important><para>Disabling or deleting the KMS key, or removing CloudTrail permissions on the key, prevents CloudTrail from logging events to the event data store, and prevents users from querying the data in the event data store that was encrypted with the key. After you associate an event data store with a KMS key, the KMS key cannot be removed or changed. Before you disable or delete a KMS key that you are using with an event data store, delete or back up your event data store.</para></important><para>CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Using multi-Region keys</a> in the <i>Key Management Service Developer Guide</i>.</para><para>Examples:</para><ul><li><para><c>alias/MyAliasName</c></para></li><li><para><c>arn:aws:kms:us-east-2:123456789012:alias/MyAliasName</c></para></li><li><para><c>arn:aws:kms:us-east-2:123456789012:key/12345678-1234-1234-1234-123456789012</c></para></li><li><para><c>12345678-1234-1234-1234-123456789012</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTEventDataStoreCmdlet.MultiRegionEnabled"> <summary> <para> <para>Specifies whether an event data store collects events from all Regions, or only from the Region in which it was created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTEventDataStoreCmdlet.Name"> <summary> <para> <para>The event data store name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTEventDataStoreCmdlet.OrganizationEnabled"> <summary> <para> <para>Specifies whether an event data store collects events logged for an organization in Organizations.</para><note><para>Only the management account for the organization can convert an organization event data store to a non-organization event data store, or convert a non-organization event data store to an organization event data store.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTEventDataStoreCmdlet.RetentionPeriod"> <summary> <para> <para>The retention period of the event data store, in days. If <c>BillingMode</c> is set to <c>EXTENDABLE_RETENTION_PRICING</c>, you can set a retention period of up to 3653 days, the equivalent of 10 years. If <c>BillingMode</c> is set to <c>FIXED_RETENTION_PRICING</c>, you can set a retention period of up to 2557 days, the equivalent of seven years.</para><para>CloudTrail Lake determines whether to retain an event by checking if the <c>eventTime</c> of the event is within the specified retention period. For example, if you set a retention period of 90 days, CloudTrail will remove events when the <c>eventTime</c> is older than 90 days.</para><note><para>If you decrease the retention period of an event data store, CloudTrail will remove any events with an <c>eventTime</c> older than the new retention period. For example, if the previous retention period was 365 days and you decrease it to 100 days, CloudTrail will remove events with an <c>eventTime</c> older than 100 days.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTEventDataStoreCmdlet.TerminationProtectionEnabled"> <summary> <para> <para>Indicates that termination protection is enabled and the event data store cannot be automatically deleted.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.UpdateCTEventDataStoreCmdlet.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.UpdateEventDataStoreResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.UpdateEventDataStoreResponse 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.UpdateCTEventDataStoreCmdlet.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.UpdateCTEventDataStoreCmdlet.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 trail settings that control what events you are logging, and how to handle 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. <c>UpdateTrail</c> must be called from the Region in which the trail was created; otherwise, an <c>InvalidHomeRegionException</c> 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 are delivered. You must use a log group that exists in your account.</para><para>Not required unless you specify <c>CloudWatchLogsRoleArn</c>.</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. You must use a role that exists in your account.</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 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.</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 Organizations, or only for the current Amazon Web Services account. The default is false, and cannot be true unless the call is made on behalf of an Amazon Web Services account that is the management account for an organization in Organizations. If the trail is not an organization trail and this is set to <c>true</c>, the trail will be created in all Amazon Web Services accounts that belong to the organization. If the trail is an organization trail and this is set to <c>false</c>, the trail will remain in the current Amazon Web Services account but be deleted from all member accounts in the organization.</para><note><para>Only the management account for the organization can convert an organization trail to a non-organization trail, or convert a non-organization trail to an organization trail.</para></note> </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>CloudTrail also supports KMS multi-Region keys. For more information about multi-Region keys, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html">Using multi-Region keys</a> in the <i>Key Management Service Developer Guide</i>.</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 <c>Name</c> 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 <c>my-_namespace</c> and <c>my--namespace</c> are not valid.</para></li><li><para>Not be in IP address format (for example, 192.168.5.4)</para></li></ul><para>If <c>Name</c> is a trail ARN, it must be in the following format.</para><para><c>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</c></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/AmazonS3/latest/userguide/bucketnamingrules.html">Amazon S3 Bucket naming rules</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/get-and-view-cloudtrail-log-files.html#cloudtrail-find-log-files">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. If you want your trail to log Insights events, be sure the event selector enables logging of the Insights event types you want configured for your trail. For more information about logging Insights events, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-insights-events-with-cloudtrail.html">Logging Insights events</a> in the <i>CloudTrail User Guide</i>. 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 <c>GetConsoleOutput</c> and <c>RunInstances</c> API operations occur in your account. </para></li><li><para> CloudTrail evaluates whether the events match your event selectors. </para></li><li><para> The <c>RunInstances</c> is a write-only event and it matches your event selector. The trail logs the event. </para></li><li><para> The <c>GetConsoleOutput</c> is a read-only event that doesn't match your event selector. The trail doesn't log the event. </para></li></ol><para> The <c>PutEventSelectors</c> operation must be called from the Region in which the trail was created; otherwise, an <c>InvalidHomeRegionException</c> 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-events-with-cloudtrail.html">Logging management events</a>, <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-data-events-with-cloudtrail.html">Logging data events</a>, and <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/WhatIsCloudTrail-Limits.html">Quotas in CloudTrail</a> in the <i>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 <c>AdvancedEventSelectors</c> or <c>EventSelectors</c>, but not both. If you apply <c>AdvancedEventSelectors</c> to a trail, any existing <c>EventSelectors</c> 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</a> in the <i>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 <c>AdvancedEventSelectors</c> or <c>EventSelectors</c>, but not both. If you apply <c>AdvancedEventSelectors</c> to a trail, any existing <c>EventSelectors</c> 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</a> in the <i>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 <c>EventSelectors</c> or <c>AdvancedEventSelectors</c> in a <c>PutEventSelectors</c> request, but not both. If you apply <c>EventSelectors</c> to a trail, any existing <c>AdvancedEventSelectors</c> 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 <c>my-_namespace</c> and <c>my--namespace</c> 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 following format.</para><para><c>arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail</c></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 or event data store. You also use <c>PutInsightSelectors</c> to turn off Insights event logging, by passing an empty list of Insights types. The valid Insights event types are <c>ApiErrorRateInsight</c> and <c>ApiCallRateInsight</c>. <para> To enable Insights on an event data store, you must specify the ARNs (or ID suffix of the ARNs) for the source event data store (<c>EventDataStore</c>) and the destination event data store (<c>InsightsDestination</c>). The source event data store logs management events and enables Insights. The destination event data store logs Insights events based upon the management event activity of the source event data store. The source and destination event data stores must belong to the same Amazon Web Services account. </para><para> To log Insights events for a trail, you must specify the name (<c>TrailName</c>) of the CloudTrail trail for which you want to change or add Insights selectors. </para><para> To log CloudTrail Insights events on API call volume, the trail or event data store must log <c>write</c> management events. To log CloudTrail Insights events on API error rate, the trail or event data store must log <c>read</c> or <c>write</c> management events. You can call <c>GetEventSelectors</c> on a trail to check whether the trail logs management events. You can call <c>GetEventDataStore</c> on an event data store to check whether the event data store logs management events. </para><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</a> in the <i>CloudTrail User Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.WriteCTInsightSelectorCmdlet.EventDataStore"> <summary> <para> <para>The ARN (or ID suffix of the ARN) of the source event data store for which you want to change or add Insights selectors. To enable Insights on an event data store, you must provide both the <c>EventDataStore</c> and <c>InsightsDestination</c> parameters.</para><para>You cannot use this parameter with the <c>TrailName</c> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.WriteCTInsightSelectorCmdlet.InsightsDestination"> <summary> <para> <para> The ARN (or ID suffix of the ARN) of the destination event data store that logs Insights events. To enable Insights on an event data store, you must provide both the <c>EventDataStore</c> and <c>InsightsDestination</c> parameters. </para><para>You cannot use this parameter with the <c>TrailName</c> parameter.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.WriteCTInsightSelectorCmdlet.InsightSelector"> <summary> <para> <para>A JSON string that contains the Insights types you want to log on a trail or event data store. <c>ApiCallRateInsight</c> and <c>ApiErrorRateInsight</c> are valid Insight types.</para><para>The <c>ApiCallRateInsight</c> Insights type analyzes write-only management API calls that are aggregated per minute against a baseline API call volume.</para><para>The <c>ApiErrorRateInsight</c> Insights type analyzes management API calls that result in error codes. The error is shown if the API call is unsuccessful.</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>You cannot use this parameter with the <c>EventDataStore</c> and <c>InsightsDestination</c> parameters.</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> <member name="T:Amazon.PowerShell.Cmdlets.CT.WriteCTResourcePolicyCmdlet"> <summary> Attaches a resource-based permission policy to a CloudTrail channel that is used for an integration with an event source outside of Amazon Web Services. For more information about resource-based policies, see <a href="https://docs.aws.amazon.com/awscloudtrail/latest/userguide/security_iam_resource-based-policy-examples.html">CloudTrail resource-based policy examples</a> in the <i>CloudTrail User Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.WriteCTResourcePolicyCmdlet.ResourceArn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the CloudTrail channel attached to the resource-based policy. The following is the format of a resource ARN: <c>arn:aws:cloudtrail:us-east-2:123456789012:channel/MyChannel</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.WriteCTResourcePolicyCmdlet.ResourcePolicy"> <summary> <para> <para> A JSON-formatted string for an Amazon Web Services resource-based policy. </para><para>The following are requirements for the resource policy:</para><ul><li><para> Contains only one action: cloudtrail-data:PutAuditEvents </para></li><li><para> Contains at least one statement. The policy can have a maximum of 20 statements. </para></li><li><para> Each statement contains at least one principal. A statement can have a maximum of 50 principals. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.WriteCTResourcePolicyCmdlet.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.PutResourcePolicyResponse). Specifying the name of a property of type Amazon.CloudTrail.Model.PutResourcePolicyResponse 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.WriteCTResourcePolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CT.WriteCTResourcePolicyCmdlet.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> |