Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. logs
  5. Integration

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.logs.Integration

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Schema for Logs Integration Resource

    Create Integration Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Integration(name: string, args: IntegrationArgs, opts?: CustomResourceOptions);
    @overload
def Integration(resource_name: str,
                args: IntegrationArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def Integration(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                integration_type: Optional[IntegrationType] = None,
                resource_config: Optional[ResourceConfigPropertiesArgs] = None,
                integration_name: Optional[str] = None)
    func NewIntegration(ctx *Context, name string, args IntegrationArgs, opts ...ResourceOption) (*Integration, error)
    public Integration(string name, IntegrationArgs args, CustomResourceOptions? opts = null)
    public Integration(String name, IntegrationArgs args)
public Integration(String name, IntegrationArgs args, CustomResourceOptions options)

    type: aws-native:logs:Integration
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 IntegrationArgs
    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 IntegrationArgs
    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 IntegrationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IntegrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IntegrationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Integration 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 Integration resource accepts the following input properties:

    IntegrationType Pulumi.AwsNative.Logs.IntegrationType
    The type of the Integration.
    ResourceConfig Pulumi.AwsNative.Logs.Inputs.ResourceConfigProperties
    OpenSearchResourceConfig for the given Integration
    IntegrationName string
    User provided identifier for integration, unique to the user account.
    IntegrationType IntegrationType
    The type of the Integration.
    ResourceConfig ResourceConfigPropertiesArgs
    OpenSearchResourceConfig for the given Integration
    IntegrationName string
    User provided identifier for integration, unique to the user account.
    integrationType IntegrationType
    The type of the Integration.
    resourceConfig ResourceConfigProperties
    OpenSearchResourceConfig for the given Integration
    integrationName String
    User provided identifier for integration, unique to the user account.
    integrationType IntegrationType
    The type of the Integration.
    resourceConfig ResourceConfigProperties
    OpenSearchResourceConfig for the given Integration
    integrationName string
    User provided identifier for integration, unique to the user account.
    integration_type IntegrationType
    The type of the Integration.
    resource_config ResourceConfigPropertiesArgs
    OpenSearchResourceConfig for the given Integration
    integration_name str
    User provided identifier for integration, unique to the user account.
    integrationType "OPENSEARCH"
    The type of the Integration.
    resourceConfig Property Map
    OpenSearchResourceConfig for the given Integration
    integrationName String
    User provided identifier for integration, unique to the user account.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Integration resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    IntegrationStatus Pulumi.AwsNative.Logs.IntegrationStatus
    Status of creation for the Integration and its resources
    Id string
    The provider-assigned unique ID for this managed resource.
    IntegrationStatus IntegrationStatus
    Status of creation for the Integration and its resources
    id String
    The provider-assigned unique ID for this managed resource.
    integrationStatus IntegrationStatus
    Status of creation for the Integration and its resources
    id string
    The provider-assigned unique ID for this managed resource.
    integrationStatus IntegrationStatus
    Status of creation for the Integration and its resources
    id str
    The provider-assigned unique ID for this managed resource.
    integration_status IntegrationStatus
    Status of creation for the Integration and its resources
    id String
    The provider-assigned unique ID for this managed resource.
    integrationStatus "PROVISIONING" | "ACTIVE" | "FAILED"
    Status of creation for the Integration and its resources

    Supporting Types

    IntegrationOpenSearchResourceConfig, IntegrationOpenSearchResourceConfigArgs

    DashboardViewerPrincipals List<string>

    Specify the ARNs of IAM roles and IAM users who you want to grant permission to for viewing the dashboards.

    In addition to specifying these users here, you must also grant them the CloudWatchOpenSearchDashboardAccess IAM policy. For more information, see IAM policies for users .

    DataSourceRoleArn string
    Specify the ARN of an IAM role that CloudWatch Logs will use to create the integration. This role must have the permissions necessary to access the OpenSearch Service collection to be able to create the dashboards. For more information about the permissions needed, see Permissions that the integration needs in the CloudWatch Logs User Guide.
    ApplicationArn string
    If you want to use an existing OpenSearch Service application for your integration with OpenSearch Service, specify it here. If you omit this, a new application will be created.
    KmsKeyArn string
    To have the vended dashboard data encrypted with AWS KMS instead of the CloudWatch Logs default encryption method, specify the ARN of the AWS KMS key that you want to use.
    RetentionDays int
    Specify how many days that you want the data derived by OpenSearch Service to be retained in the index that the dashboard refers to. This also sets the maximum time period that you can choose when viewing data in the dashboard. Choosing a longer time frame will incur additional costs.
    DashboardViewerPrincipals []string

    Specify the ARNs of IAM roles and IAM users who you want to grant permission to for viewing the dashboards.

    In addition to specifying these users here, you must also grant them the CloudWatchOpenSearchDashboardAccess IAM policy. For more information, see IAM policies for users .

    DataSourceRoleArn string
    Specify the ARN of an IAM role that CloudWatch Logs will use to create the integration. This role must have the permissions necessary to access the OpenSearch Service collection to be able to create the dashboards. For more information about the permissions needed, see Permissions that the integration needs in the CloudWatch Logs User Guide.
    ApplicationArn string
    If you want to use an existing OpenSearch Service application for your integration with OpenSearch Service, specify it here. If you omit this, a new application will be created.
    KmsKeyArn string
    To have the vended dashboard data encrypted with AWS KMS instead of the CloudWatch Logs default encryption method, specify the ARN of the AWS KMS key that you want to use.
    RetentionDays int
    Specify how many days that you want the data derived by OpenSearch Service to be retained in the index that the dashboard refers to. This also sets the maximum time period that you can choose when viewing data in the dashboard. Choosing a longer time frame will incur additional costs.
    dashboardViewerPrincipals List<String>

    Specify the ARNs of IAM roles and IAM users who you want to grant permission to for viewing the dashboards.

    In addition to specifying these users here, you must also grant them the CloudWatchOpenSearchDashboardAccess IAM policy. For more information, see IAM policies for users .

    dataSourceRoleArn String
    Specify the ARN of an IAM role that CloudWatch Logs will use to create the integration. This role must have the permissions necessary to access the OpenSearch Service collection to be able to create the dashboards. For more information about the permissions needed, see Permissions that the integration needs in the CloudWatch Logs User Guide.
    applicationArn String
    If you want to use an existing OpenSearch Service application for your integration with OpenSearch Service, specify it here. If you omit this, a new application will be created.
    kmsKeyArn String
    To have the vended dashboard data encrypted with AWS KMS instead of the CloudWatch Logs default encryption method, specify the ARN of the AWS KMS key that you want to use.
    retentionDays Integer
    Specify how many days that you want the data derived by OpenSearch Service to be retained in the index that the dashboard refers to. This also sets the maximum time period that you can choose when viewing data in the dashboard. Choosing a longer time frame will incur additional costs.
    dashboardViewerPrincipals string[]

    Specify the ARNs of IAM roles and IAM users who you want to grant permission to for viewing the dashboards.

    In addition to specifying these users here, you must also grant them the CloudWatchOpenSearchDashboardAccess IAM policy. For more information, see IAM policies for users .

    dataSourceRoleArn string
    Specify the ARN of an IAM role that CloudWatch Logs will use to create the integration. This role must have the permissions necessary to access the OpenSearch Service collection to be able to create the dashboards. For more information about the permissions needed, see Permissions that the integration needs in the CloudWatch Logs User Guide.
    applicationArn string
    If you want to use an existing OpenSearch Service application for your integration with OpenSearch Service, specify it here. If you omit this, a new application will be created.
    kmsKeyArn string
    To have the vended dashboard data encrypted with AWS KMS instead of the CloudWatch Logs default encryption method, specify the ARN of the AWS KMS key that you want to use.
    retentionDays number
    Specify how many days that you want the data derived by OpenSearch Service to be retained in the index that the dashboard refers to. This also sets the maximum time period that you can choose when viewing data in the dashboard. Choosing a longer time frame will incur additional costs.
    dashboard_viewer_principals Sequence[str]

    Specify the ARNs of IAM roles and IAM users who you want to grant permission to for viewing the dashboards.

    In addition to specifying these users here, you must also grant them the CloudWatchOpenSearchDashboardAccess IAM policy. For more information, see IAM policies for users .

    data_source_role_arn str
    Specify the ARN of an IAM role that CloudWatch Logs will use to create the integration. This role must have the permissions necessary to access the OpenSearch Service collection to be able to create the dashboards. For more information about the permissions needed, see Permissions that the integration needs in the CloudWatch Logs User Guide.
    application_arn str
    If you want to use an existing OpenSearch Service application for your integration with OpenSearch Service, specify it here. If you omit this, a new application will be created.
    kms_key_arn str
    To have the vended dashboard data encrypted with AWS KMS instead of the CloudWatch Logs default encryption method, specify the ARN of the AWS KMS key that you want to use.
    retention_days int
    Specify how many days that you want the data derived by OpenSearch Service to be retained in the index that the dashboard refers to. This also sets the maximum time period that you can choose when viewing data in the dashboard. Choosing a longer time frame will incur additional costs.
    dashboardViewerPrincipals List<String>

    Specify the ARNs of IAM roles and IAM users who you want to grant permission to for viewing the dashboards.

    In addition to specifying these users here, you must also grant them the CloudWatchOpenSearchDashboardAccess IAM policy. For more information, see IAM policies for users .

    dataSourceRoleArn String
    Specify the ARN of an IAM role that CloudWatch Logs will use to create the integration. This role must have the permissions necessary to access the OpenSearch Service collection to be able to create the dashboards. For more information about the permissions needed, see Permissions that the integration needs in the CloudWatch Logs User Guide.
    applicationArn String
    If you want to use an existing OpenSearch Service application for your integration with OpenSearch Service, specify it here. If you omit this, a new application will be created.
    kmsKeyArn String
    To have the vended dashboard data encrypted with AWS KMS instead of the CloudWatch Logs default encryption method, specify the ARN of the AWS KMS key that you want to use.
    retentionDays Number
    Specify how many days that you want the data derived by OpenSearch Service to be retained in the index that the dashboard refers to. This also sets the maximum time period that you can choose when viewing data in the dashboard. Choosing a longer time frame will incur additional costs.

    IntegrationStatus, IntegrationStatusArgs

    Provisioning
    PROVISIONING
    Active
    ACTIVE
    Failed
    FAILED
    IntegrationStatusProvisioning
    PROVISIONING
    IntegrationStatusActive
    ACTIVE
    IntegrationStatusFailed
    FAILED
    Provisioning
    PROVISIONING
    Active
    ACTIVE
    Failed
    FAILED
    Provisioning
    PROVISIONING
    Active
    ACTIVE
    Failed
    FAILED
    PROVISIONING
    PROVISIONING
    ACTIVE
    ACTIVE
    FAILED
    FAILED
    "PROVISIONING"
    PROVISIONING
    "ACTIVE"
    ACTIVE
    "FAILED"
    FAILED

    IntegrationType, IntegrationTypeArgs

    Opensearch
    OPENSEARCH
    IntegrationTypeOpensearch
    OPENSEARCH
    Opensearch
    OPENSEARCH
    Opensearch
    OPENSEARCH
    OPENSEARCH
    OPENSEARCH
    "OPENSEARCH"
    OPENSEARCH

    ResourceConfigProperties, ResourceConfigPropertiesArgs

    OpenSearchResourceConfig Pulumi.AwsNative.Logs.Inputs.IntegrationOpenSearchResourceConfig
    This structure contains configuration details about an integration between CloudWatch Logs and OpenSearch Service.
    OpenSearchResourceConfig IntegrationOpenSearchResourceConfig
    This structure contains configuration details about an integration between CloudWatch Logs and OpenSearch Service.
    openSearchResourceConfig IntegrationOpenSearchResourceConfig
    This structure contains configuration details about an integration between CloudWatch Logs and OpenSearch Service.
    openSearchResourceConfig IntegrationOpenSearchResourceConfig
    This structure contains configuration details about an integration between CloudWatch Logs and OpenSearch Service.
    open_search_resource_config IntegrationOpenSearchResourceConfig
    This structure contains configuration details about an integration between CloudWatch Logs and OpenSearch Service.
    openSearchResourceConfig Property Map
    This structure contains configuration details about an integration between CloudWatch Logs and OpenSearch Service.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native