We recommend new projects start with resources from the AWS provider.
aws-native.observabilityadmin.getOrganizationTelemetryRule
We recommend new projects start with resources from the AWS provider.
The AWS::ObservabilityAdmin::OrganizationTelemetryRule resource defines a CloudWatch Observability Admin Organization Telemetry Rule.
Using getOrganizationTelemetryRule
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getOrganizationTelemetryRule(args: GetOrganizationTelemetryRuleArgs, opts?: InvokeOptions): Promise<GetOrganizationTelemetryRuleResult>
function getOrganizationTelemetryRuleOutput(args: GetOrganizationTelemetryRuleOutputArgs, opts?: InvokeOptions): Output<GetOrganizationTelemetryRuleResult>def get_organization_telemetry_rule(rule_arn: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetOrganizationTelemetryRuleResult
def get_organization_telemetry_rule_output(rule_arn: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetOrganizationTelemetryRuleResult]func LookupOrganizationTelemetryRule(ctx *Context, args *LookupOrganizationTelemetryRuleArgs, opts ...InvokeOption) (*LookupOrganizationTelemetryRuleResult, error)
func LookupOrganizationTelemetryRuleOutput(ctx *Context, args *LookupOrganizationTelemetryRuleOutputArgs, opts ...InvokeOption) LookupOrganizationTelemetryRuleResultOutput> Note: This function is named LookupOrganizationTelemetryRule in the Go SDK.
public static class GetOrganizationTelemetryRule
{
public static Task<GetOrganizationTelemetryRuleResult> InvokeAsync(GetOrganizationTelemetryRuleArgs args, InvokeOptions? opts = null)
public static Output<GetOrganizationTelemetryRuleResult> Invoke(GetOrganizationTelemetryRuleInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetOrganizationTelemetryRuleResult> getOrganizationTelemetryRule(GetOrganizationTelemetryRuleArgs args, InvokeOptions options)
public static Output<GetOrganizationTelemetryRuleResult> getOrganizationTelemetryRule(GetOrganizationTelemetryRuleArgs args, InvokeOptions options)
fn::invoke:
function: aws-native:observabilityadmin:getOrganizationTelemetryRule
arguments:
# arguments dictionaryThe following arguments are supported:
- Rule
Arn string - The arn of the organization telemetry rule
- Rule
Arn string - The arn of the organization telemetry rule
- rule
Arn String - The arn of the organization telemetry rule
- rule
Arn string - The arn of the organization telemetry rule
- rule_
arn str - The arn of the organization telemetry rule
- rule
Arn String - The arn of the organization telemetry rule
getOrganizationTelemetryRule Result
The following output properties are available:
- Rule
Pulumi.
Aws Native. Observability Admin. Outputs. Organization Telemetry Rule Telemetry Rule - The name of the organization telemetry rule.
- Rule
Arn string - The arn of the organization telemetry rule
-
List<Pulumi.
Aws Native. Outputs. 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
Arn string - The arn of the organization telemetry rule
- 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
Arn String - The arn 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
Arn string - The arn of the organization telemetry rule
- 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_
arn str - The arn of the organization telemetry rule
- Sequence[root_Tag]
- An array of key-value pairs to apply to this resource
- rule Property Map
- The name of the organization telemetry rule.
- rule
Arn String - The arn of the organization telemetry rule
- List<Property Map>
- An array of key-value pairs to apply to this resource
Supporting Types
OrganizationTelemetryRuleDestinationType
OrganizationTelemetryRuleResourceType
OrganizationTelemetryRuleTelemetryDestinationConfiguration
- 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
- 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
OrganizationTelemetryRuleVpcFlowLogParameters
- 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
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.
