Package software.amazon.awscdk.services.observabilityadmin

Class CfnOrganizationTelemetryRule

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.observabilityadmin.CfnOrganizationTelemetryRule
All Implemented Interfaces:
IInspectable, ITaggableV2, IOrganizationTelemetryRuleRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:44.153Z") @Stability(Stable) public class CfnOrganizationTelemetryRule extends CfnResource implements IInspectable, IOrganizationTelemetryRuleRef, ITaggableV2
Retrieves the details of a specific organization centralization rule.

This operation can only be called by the organization's management account or a delegated administrator account.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.observabilityadmin.*;
 CfnOrganizationTelemetryRule cfnOrganizationTelemetryRule = CfnOrganizationTelemetryRule.Builder.create(this, "MyCfnOrganizationTelemetryRule")
         .rule(TelemetryRuleProperty.builder()
                 .resourceType("resourceType")
                 .telemetryType("telemetryType")
                 // the properties below are optional
                 .destinationConfiguration(TelemetryDestinationConfigurationProperty.builder()
                         .destinationPattern("destinationPattern")
                         .destinationType("destinationType")
                         .retentionInDays(123)
                         .vpcFlowLogParameters(VPCFlowLogParametersProperty.builder()
                                 .logFormat("logFormat")
                                 .maxAggregationInterval(123)
                                 .trafficType("trafficType")
                                 .build())
                         .build())
                 .scope("scope")
                 .selectionCriteria("selectionCriteria")
                 .build())
         .ruleName("ruleName")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnOrganizationTelemetryRule

      protected CfnOrganizationTelemetryRule(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnOrganizationTelemetryRule

      protected CfnOrganizationTelemetryRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnOrganizationTelemetryRule

      @Stability(Stable) public CfnOrganizationTelemetryRule(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnOrganizationTelemetryRuleProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrRuleArn

      @Stability(Stable) @NotNull public String getAttrRuleArn()
      The arn of the organization telemetry rule.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getOrganizationTelemetryRuleRef

      @Stability(Stable) @NotNull public OrganizationTelemetryRuleReference getOrganizationTelemetryRuleRef()
      A reference to a OrganizationTelemetryRule resource.
      Specified by:
      getOrganizationTelemetryRuleRef in interface IOrganizationTelemetryRuleRef

    • getRule

      @Stability(Stable) @NotNull public Object getRule()
      The name of the organization telemetry rule.

      Returns union: either IResolvable or CfnOrganizationTelemetryRule.TelemetryRuleProperty

    • setRule

      @Stability(Stable) public void setRule(@NotNull IResolvable value)
      The name of the organization telemetry rule.

    • setRule

      @Stability(Stable) public void setRule(@NotNull CfnOrganizationTelemetryRule.TelemetryRuleProperty value)
      The name of the organization telemetry rule.

    • getRuleName

      @Stability(Stable) @NotNull public String getRuleName()
      The name of the organization centralization rule.

    • setRuleName

      @Stability(Stable) public void setRuleName(@NotNull String value)
      The name of the organization centralization rule.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Lists all tags attached to the specified telemetry rule resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Lists all tags attached to the specified telemetry rule resource.