Skip to content
v2.277.0

CfnIntegrationProps Struct ​

Properties for defining a CfnIntegration.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_logs as logs } from 'aws-cdk-lib';
const cfnIntegrationProps: logs.CfnIntegrationProps = {
  integrationName: 'integrationName',
  integrationType: 'integrationType',
  resourceConfig: {
    openSearchResourceConfig: {
      dashboardViewerPrincipals: ['dashboardViewerPrincipals'],
      dataSourceRoleArn: 'dataSourceRoleArn',

      // the properties below are optional
      applicationArn: 'applicationArn',
      kmsKeyArn: 'kmsKeyArn',
      retentionDays: 123,
    },
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_logs as logs

cfn_integration_props = logs.CfnIntegrationProps(
    integration_name="integrationName",
    integration_type="integrationType",
    resource_config=logs.CfnIntegration.ResourceConfigProperty(
        open_search_resource_config=logs.CfnIntegration.OpenSearchResourceConfigProperty(
            dashboard_viewer_principals=["dashboardViewerPrincipals"],
            data_source_role_arn="dataSourceRoleArn",

            # the properties below are optional
            application_arn="applicationArn",
            kms_key_arn="kmsKeyArn",
            retention_days=123
        )
    )
)
java
// 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.*;

CfnIntegrationProps cfnIntegrationProps = CfnIntegrationProps.builder()
        .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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Logs;

var cfnIntegrationProps = new CfnIntegrationProps {
    IntegrationName = "integrationName",
    IntegrationType = "integrationType",
    ResourceConfig = new ResourceConfigProperty {
        OpenSearchResourceConfig = new OpenSearchResourceConfigProperty {
            DashboardViewerPrincipals = new [] { "dashboardViewerPrincipals" },
            DataSourceRoleArn = "dataSourceRoleArn",

            // the properties below are optional
            ApplicationArn = "applicationArn",
            KmsKeyArn = "kmsKeyArn",
            RetentionDays = 123
        }
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnIntegrationProps := &CfnIntegrationProps{
	IntegrationName: jsii.String("integrationName"),
	IntegrationType: jsii.String("integrationType"),
	ResourceConfig: &ResourceConfigProperty{
		OpenSearchResourceConfig: &OpenSearchResourceConfigProperty{
			DashboardViewerPrincipals: []*string{
				jsii.String("dashboardViewerPrincipals"),
			},
			DataSourceRoleArn: jsii.String("dataSourceRoleArn"),

			// the properties below are optional
			ApplicationArn: jsii.String("applicationArn"),
			KmsKeyArn: jsii.String("kmsKeyArn"),
			RetentionDays: jsii.Number(123),
		},
	},
}

Properties ​

integrationNamestringintegration_namestrintegrationNameStringIntegrationNamestringIntegrationName*stringrequired#
The name of this integration.
integrationTypestringintegration_typestrintegrationTypeStringIntegrationTypestringIntegrationType*stringrequired#
The type of integration.

Integrations with OpenSearch Service have the type OPENSEARCH .

resourceConfigIResolvable | CfnIntegration.ResourceConfigPropertyresource_configtyping.Union[IResolvable, ResourceConfigProperty]resourceConfigIResolvableResourceConfigIResolvableResourceConfiginterface{}required#
This structure contains configuration details about an integration between CloudWatch Logs and another entity.