Package software.amazon.awscdk.services.logs

Class CfnIntegration

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.logs.CfnIntegration
All Implemented Interfaces:
IInspectable, IIntegrationRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:41.694Z") @Stability(Stable) public class CfnIntegration extends CfnResource implements IInspectable, IIntegrationRef
Creates an integration between CloudWatch Logs and another service in this account.

Currently, only integrations with OpenSearch Service are supported, and currently you can have only one integration in your account.

Integrating with OpenSearch Service makes it possible for you to create curated vended logs dashboards, powered by OpenSearch Service analytics. For more information, see Vended log dashboards powered by Amazon OpenSearch Service .

You can use this operation only to create a new integration. You can't modify an existing integration.

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.logs.*;
 CfnIntegration cfnIntegration = CfnIntegration.Builder.create(this, "MyCfnIntegration")
         .integrationName("integrationName")
         .integrationType("integrationType")
         .resourceConfig(ResourceConfigProperty.builder()
                 .openSearchResourceConfig(OpenSearchResourceConfigProperty.builder()
                         .dashboardViewerPrincipals(List.of("dashboardViewerPrincipals"))
                         .dataSourceRoleArn("dataSourceRoleArn")
                         // the properties below are optional
                         .applicationArn("applicationArn")
                         .kmsKeyArn("kmsKeyArn")
                         .retentionDays(123)
                         .build())
                 .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

    • CfnIntegration

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

    • CfnIntegration

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

    • CfnIntegration

      @Stability(Stable) public CfnIntegration(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnIntegrationProps 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.

    • getAttrIntegrationStatus

      @Stability(Stable) @NotNull public String getAttrIntegrationStatus()
      The current status of this integration.

    • getCfnProperties

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

    • getIntegrationRef

      @Stability(Stable) @NotNull public IntegrationReference getIntegrationRef()
      A reference to a Integration resource.
      Specified by:
      getIntegrationRef in interface IIntegrationRef

    • getIntegrationName

      @Stability(Stable) @NotNull public String getIntegrationName()
      The name of this integration.

    • setIntegrationName

      @Stability(Stable) public void setIntegrationName(@NotNull String value)
      The name of this integration.

    • getIntegrationType

      @Stability(Stable) @NotNull public String getIntegrationType()
      The type of integration.

    • setIntegrationType

      @Stability(Stable) public void setIntegrationType(@NotNull String value)
      The type of integration.

    • getResourceConfig

      @Stability(Stable) @NotNull public Object getResourceConfig()
      This structure contains configuration details about an integration between CloudWatch Logs and another entity.

      Returns union: either IResolvable or CfnIntegration.ResourceConfigProperty

    • setResourceConfig

      @Stability(Stable) public void setResourceConfig(@NotNull IResolvable value)
      This structure contains configuration details about an integration between CloudWatch Logs and another entity.

    • setResourceConfig

      @Stability(Stable) public void setResourceConfig(@NotNull CfnIntegration.ResourceConfigProperty value)
      This structure contains configuration details about an integration between CloudWatch Logs and another entity.