AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the CloudWatch Observability Admin Service CreateTelemetryRule API operation.

Syntax

New-CWOADMNTelemetryRule
-RuleName <String>
-DestinationConfiguration_DestinationPattern <String>
-DestinationConfiguration_DestinationType <DestinationType>
-VPCFlowLogParameters_LogFormat <String>
-VPCFlowLogParameters_MaxAggregationInterval <Int32>
-Rule_ResourceType <ResourceType>
-DestinationConfiguration_RetentionInDay <Int32>
-Rule_Scope <String>
-Rule_SelectionCriterion <String>
-Tag <Hashtable>
-Rule_TelemetryType <TelemetryType>
-VPCFlowLogParameters_TrafficType <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonObservabilityAdminConfig>

Description

Creates a telemetry rule that defines how telemetry should be configured for Amazon Web Services resources in your account. The rule specifies which resources should have telemetry enabled and how that telemetry data should be collected based on resource type, telemetry type, and selection criteria.

Parameters

-ClientConfig <AmazonObservabilityAdminConfig>
Amazon.PowerShell.Cmdlets.CWOADMN.AmazonObservabilityAdminClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DestinationConfiguration_DestinationPattern <String>
The pattern used to generate the destination path or name, supporting macros like <resourceId> and <accountId>.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRule_DestinationConfiguration_DestinationPattern
-DestinationConfiguration_DestinationType <DestinationType>
The type of destination for the telemetry data (e.g., "Amazon CloudWatch Logs", "S3").
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRule_DestinationConfiguration_DestinationType
-DestinationConfiguration_RetentionInDay <Int32>
The number of days to retain the telemetry data in the destination.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRule_DestinationConfiguration_RetentionInDays
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Rule_ResourceType <ResourceType>
The type of Amazon Web Services resource to configure telemetry for (e.g., "AWS::EC2::VPC").
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Rule_Scope <String>
The organizational scope to which the rule applies, specified using accounts or organizational units.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Rule_SelectionCriterion <String>
Criteria for selecting which resources the rule applies to, such as resource tags.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRule_SelectionCriteria
-Rule_TelemetryType <TelemetryType>
The type of telemetry to collect (Logs, Metrics, or Traces).
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-RuleName <String>
A unique name for the telemetry rule being created.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'RuleArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ObservabilityAdmin.Model.CreateTelemetryRuleResponse). Specifying the name of a property of type Amazon.ObservabilityAdmin.Model.CreateTelemetryRuleResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
The key-value pairs to associate with the telemetry rule resource for categorization and management purposes. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-VPCFlowLogParameters_LogFormat <String>
The format in which VPC Flow Log entries should be logged.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRule_DestinationConfiguration_VPCFlowLogParameters_LogFormat
-VPCFlowLogParameters_MaxAggregationInterval <Int32>
The maximum interval in seconds between the capture of flow log records.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRule_DestinationConfiguration_VPCFlowLogParameters_MaxAggregationInterval
-VPCFlowLogParameters_TrafficType <String>
The type of traffic to log (ACCEPT, REJECT, or ALL).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRule_DestinationConfiguration_VPCFlowLogParameters_TrafficType

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

System.String or Amazon.ObservabilityAdmin.Model.CreateTelemetryRuleResponse
This cmdlet returns a System.String object. The service call response (type Amazon.ObservabilityAdmin.Model.CreateTelemetryRuleResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z