We recommend new projects start with resources from the AWS provider.
aws-native.observabilityadmin.OrganizationTelemetryRule
We recommend new projects start with resources from the AWS provider.
The AWS::ObservabilityAdmin::OrganizationTelemetryRule resource defines a CloudWatch Observability Admin Organization Telemetry Rule.
Create OrganizationTelemetryRule Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new OrganizationTelemetryRule(name: string, args: OrganizationTelemetryRuleArgs, opts?: CustomResourceOptions);@overload
def OrganizationTelemetryRule(resource_name: str,
args: OrganizationTelemetryRuleArgs,
opts: Optional[ResourceOptions] = None)
@overload
def OrganizationTelemetryRule(resource_name: str,
opts: Optional[ResourceOptions] = None,
rule: Optional[OrganizationTelemetryRuleTelemetryRuleArgs] = None,
rule_name: Optional[str] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)func NewOrganizationTelemetryRule(ctx *Context, name string, args OrganizationTelemetryRuleArgs, opts ...ResourceOption) (*OrganizationTelemetryRule, error)public OrganizationTelemetryRule(string name, OrganizationTelemetryRuleArgs args, CustomResourceOptions? opts = null)
public OrganizationTelemetryRule(String name, OrganizationTelemetryRuleArgs args)
public OrganizationTelemetryRule(String name, OrganizationTelemetryRuleArgs args, CustomResourceOptions options)
type: aws-native:observabilityadmin:OrganizationTelemetryRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args OrganizationTelemetryRuleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args OrganizationTelemetryRuleArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args OrganizationTelemetryRuleArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args OrganizationTelemetryRuleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args OrganizationTelemetryRuleArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
OrganizationTelemetryRule Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The OrganizationTelemetryRule resource accepts the following input properties:
- Rule
Pulumi.
Aws Native. Observability Admin. Inputs. Organization Telemetry Rule Telemetry Rule - The name of the organization telemetry rule.
- Rule
Name string - The name of the organization telemetry rule
-
List<Pulumi.
Aws Native. Inputs. Tag> - An array of key-value pairs to apply to this resource
- Rule
Organization
Telemetry Rule Telemetry Rule Args - The name of the organization telemetry rule.
- Rule
Name string - The name of the organization telemetry rule
-
Tag
Args - An array of key-value pairs to apply to this resource
- rule
Organization
Telemetry Rule Telemetry Rule - The name of the organization telemetry rule.
- rule
Name String - The name of the organization telemetry rule
- List<Tag>
- An array of key-value pairs to apply to this resource
- rule
Organization
Telemetry Rule Telemetry Rule - The name of the organization telemetry rule.
- rule
Name string - The name of the organization telemetry rule
- Tag[]
- An array of key-value pairs to apply to this resource
- rule
Organization
Telemetry Rule Telemetry Rule Args - The name of the organization telemetry rule.
- rule_
name str - The name of the organization telemetry rule
-
Sequence[Tag
Args] - An array of key-value pairs to apply to this resource
- rule Property Map
- The name of the organization telemetry rule.
- rule
Name String - The name of the organization telemetry rule
- List<Property Map>
- An array of key-value pairs to apply to this resource
Outputs
All input properties are implicitly available as output properties. Additionally, the OrganizationTelemetryRule resource produces the following output properties:
Supporting Types
OrganizationTelemetryRuleDestinationType, OrganizationTelemetryRuleDestinationTypeArgs
- Cloud
Watch Logs - cloud-watch-logs
- Organization
Telemetry Rule Destination Type Cloud Watch Logs - cloud-watch-logs
- Cloud
Watch Logs - cloud-watch-logs
- Cloud
Watch Logs - cloud-watch-logs
- CLOUD_WATCH_LOGS
- cloud-watch-logs
- "cloud-watch-logs"
- cloud-watch-logs
OrganizationTelemetryRuleResourceType, OrganizationTelemetryRuleResourceTypeArgs
- Awsec2vpc
- AWS::EC2::VPC
- Organization
Telemetry Rule Resource Type Awsec2vpc - AWS::EC2::VPC
- Awsec2vpc
- AWS::EC2::VPC
- Awsec2vpc
- AWS::EC2::VPC
- AWSEC2VPC
- AWS::EC2::VPC
- "AWS::EC2::VPC"
- AWS::EC2::VPC
OrganizationTelemetryRuleTelemetryDestinationConfiguration, OrganizationTelemetryRuleTelemetryDestinationConfigurationArgs
The destination configuration for telemetry data- Destination
Pattern string - The pattern used to generate the destination path or name, supporting macros like and .
- Destination
Type Pulumi.Aws Native. Observability Admin. Organization Telemetry Rule Destination Type - The type of destination for the telemetry data (e.g., "Amazon CloudWatch Logs", "S3").
- Retention
In intDays - The number of days to retain the telemetry data in the destination.
- Vpc
Flow Pulumi.Log Parameters Aws Native. Observability Admin. Inputs. Organization Telemetry Rule Vpc Flow Log Parameters - Configuration parameters specific to VPC Flow Logs when VPC is the resource type.
- Destination
Pattern string - The pattern used to generate the destination path or name, supporting macros like and .
- Destination
Type OrganizationTelemetry Rule Destination Type - The type of destination for the telemetry data (e.g., "Amazon CloudWatch Logs", "S3").
- Retention
In intDays - The number of days to retain the telemetry data in the destination.
- Vpc
Flow OrganizationLog Parameters Telemetry Rule Vpc Flow Log Parameters - Configuration parameters specific to VPC Flow Logs when VPC is the resource type.
- destination
Pattern String - The pattern used to generate the destination path or name, supporting macros like and .
- destination
Type OrganizationTelemetry Rule Destination Type - The type of destination for the telemetry data (e.g., "Amazon CloudWatch Logs", "S3").
- retention
In IntegerDays - The number of days to retain the telemetry data in the destination.
- vpc
Flow OrganizationLog Parameters Telemetry Rule Vpc Flow Log Parameters - Configuration parameters specific to VPC Flow Logs when VPC is the resource type.
- destination
Pattern string - The pattern used to generate the destination path or name, supporting macros like and .
- destination
Type OrganizationTelemetry Rule Destination Type - The type of destination for the telemetry data (e.g., "Amazon CloudWatch Logs", "S3").
- retention
In numberDays - The number of days to retain the telemetry data in the destination.
- vpc
Flow OrganizationLog Parameters Telemetry Rule Vpc Flow Log Parameters - Configuration parameters specific to VPC Flow Logs when VPC is the resource type.
- destination_
pattern str - The pattern used to generate the destination path or name, supporting macros like and .
- destination_
type OrganizationTelemetry Rule Destination Type - The type of destination for the telemetry data (e.g., "Amazon CloudWatch Logs", "S3").
- retention_
in_ intdays - The number of days to retain the telemetry data in the destination.
- vpc_
flow_ Organizationlog_ parameters Telemetry Rule Vpc Flow Log Parameters - Configuration parameters specific to VPC Flow Logs when VPC is the resource type.
- destination
Pattern String - The pattern used to generate the destination path or name, supporting macros like and .
- destination
Type "cloud-watch-logs" - The type of destination for the telemetry data (e.g., "Amazon CloudWatch Logs", "S3").
- retention
In NumberDays - The number of days to retain the telemetry data in the destination.
- vpc
Flow Property MapLog Parameters - Configuration parameters specific to VPC Flow Logs when VPC is the resource type.
OrganizationTelemetryRuleTelemetryRule, OrganizationTelemetryRuleTelemetryRuleArgs
The telemetry rule- Resource
Type Pulumi.Aws Native. Observability Admin. Organization Telemetry Rule Resource Type - The type of AWS resource to configure telemetry for (e.g., "AWS::EC2::VPC").
- Telemetry
Type Pulumi.Aws Native. Observability Admin. Organization Telemetry Rule Telemetry Type - The type of telemetry to collect (Logs, Metrics, or Traces).
- Destination
Configuration Pulumi.Aws Native. Observability Admin. Inputs. Organization Telemetry Rule Telemetry Destination Configuration - Configuration specifying where and how the telemetry data should be delivered.
- Scope string
- The organizational scope to which the rule applies, specified using accounts or organizational units.
- Selection
Criteria string - Criteria for selecting which resources the rule applies to, such as resource tags.
- Resource
Type OrganizationTelemetry Rule Resource Type - The type of AWS resource to configure telemetry for (e.g., "AWS::EC2::VPC").
- Telemetry
Type OrganizationTelemetry Rule Telemetry Type - The type of telemetry to collect (Logs, Metrics, or Traces).
- Destination
Configuration OrganizationTelemetry Rule Telemetry Destination Configuration - Configuration specifying where and how the telemetry data should be delivered.
- Scope string
- The organizational scope to which the rule applies, specified using accounts or organizational units.
- Selection
Criteria string - Criteria for selecting which resources the rule applies to, such as resource tags.
- resource
Type OrganizationTelemetry Rule Resource Type - The type of AWS resource to configure telemetry for (e.g., "AWS::EC2::VPC").
- telemetry
Type OrganizationTelemetry Rule Telemetry Type - The type of telemetry to collect (Logs, Metrics, or Traces).
- destination
Configuration OrganizationTelemetry Rule Telemetry Destination Configuration - Configuration specifying where and how the telemetry data should be delivered.
- scope String
- The organizational scope to which the rule applies, specified using accounts or organizational units.
- selection
Criteria String - Criteria for selecting which resources the rule applies to, such as resource tags.
- resource
Type OrganizationTelemetry Rule Resource Type - The type of AWS resource to configure telemetry for (e.g., "AWS::EC2::VPC").
- telemetry
Type OrganizationTelemetry Rule Telemetry Type - The type of telemetry to collect (Logs, Metrics, or Traces).
- destination
Configuration OrganizationTelemetry Rule Telemetry Destination Configuration - Configuration specifying where and how the telemetry data should be delivered.
- scope string
- The organizational scope to which the rule applies, specified using accounts or organizational units.
- selection
Criteria string - Criteria for selecting which resources the rule applies to, such as resource tags.
- resource_
type OrganizationTelemetry Rule Resource Type - The type of AWS resource to configure telemetry for (e.g., "AWS::EC2::VPC").
- telemetry_
type OrganizationTelemetry Rule Telemetry Type - The type of telemetry to collect (Logs, Metrics, or Traces).
- destination_
configuration OrganizationTelemetry Rule Telemetry Destination Configuration - Configuration specifying where and how the telemetry data should be delivered.
- scope str
- The organizational scope to which the rule applies, specified using accounts or organizational units.
- selection_
criteria str - Criteria for selecting which resources the rule applies to, such as resource tags.
- resource
Type "AWS::EC2::VPC" - The type of AWS resource to configure telemetry for (e.g., "AWS::EC2::VPC").
- telemetry
Type "Logs" - The type of telemetry to collect (Logs, Metrics, or Traces).
- destination
Configuration Property Map - Configuration specifying where and how the telemetry data should be delivered.
- scope String
- The organizational scope to which the rule applies, specified using accounts or organizational units.
- selection
Criteria String - Criteria for selecting which resources the rule applies to, such as resource tags.
OrganizationTelemetryRuleTelemetryType, OrganizationTelemetryRuleTelemetryTypeArgs
- Logs
- Logs
- Organization
Telemetry Rule Telemetry Type Logs - Logs
- Logs
- Logs
- Logs
- Logs
- LOGS
- Logs
- "Logs"
- Logs
OrganizationTelemetryRuleVpcFlowLogParameters, OrganizationTelemetryRuleVpcFlowLogParametersArgs
Telemetry parameters for VPC Flow logs- Log
Format string - The fields to include in the flow log record. If you omit this parameter, the flow log is created using the default format.
- Max
Aggregation intInterval - The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record. Default is 600s.
- Traffic
Type string - The type of traffic captured for the flow log. Default is ALL
- Log
Format string - The fields to include in the flow log record. If you omit this parameter, the flow log is created using the default format.
- Max
Aggregation intInterval - The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record. Default is 600s.
- Traffic
Type string - The type of traffic captured for the flow log. Default is ALL
- log
Format String - The fields to include in the flow log record. If you omit this parameter, the flow log is created using the default format.
- max
Aggregation IntegerInterval - The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record. Default is 600s.
- traffic
Type String - The type of traffic captured for the flow log. Default is ALL
- log
Format string - The fields to include in the flow log record. If you omit this parameter, the flow log is created using the default format.
- max
Aggregation numberInterval - The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record. Default is 600s.
- traffic
Type string - The type of traffic captured for the flow log. Default is ALL
- log_
format str - The fields to include in the flow log record. If you omit this parameter, the flow log is created using the default format.
- max_
aggregation_ intinterval - The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record. Default is 600s.
- traffic_
type str - The type of traffic captured for the flow log. Default is ALL
- log
Format String - The fields to include in the flow log record. If you omit this parameter, the flow log is created using the default format.
- max
Aggregation NumberInterval - The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record. Default is 600s.
- traffic
Type String - The type of traffic captured for the flow log. Default is ALL
Tag, TagArgs
A set of tags to apply to the resource.Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
