1. Packages
  2. AWS
  3. API Docs
  4. appconfig
  5. EventIntegration
AWS v6.63.0 published on Wednesday, Dec 4, 2024 by Pulumi

aws.appconfig.EventIntegration

Explore with Pulumi AI

aws logo
AWS v6.63.0 published on Wednesday, Dec 4, 2024 by Pulumi

    Provides an Amazon AppIntegrations Event Integration resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.appconfig.EventIntegration("example", {
        name: "example-name",
        description: "Example Description",
        eventbridgeBus: "default",
        eventFilter: {
            source: "aws.partner/examplepartner.com",
        },
        tags: {
            Name: "Example Event Integration",
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.appconfig.EventIntegration("example",
        name="example-name",
        description="Example Description",
        eventbridge_bus="default",
        event_filter={
            "source": "aws.partner/examplepartner.com",
        },
        tags={
            "Name": "Example Event Integration",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/appconfig"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := appconfig.NewEventIntegration(ctx, "example", &appconfig.EventIntegrationArgs{
    			Name:           pulumi.String("example-name"),
    			Description:    pulumi.String("Example Description"),
    			EventbridgeBus: pulumi.String("default"),
    			EventFilter: &appconfig.EventIntegrationEventFilterArgs{
    				Source: pulumi.String("aws.partner/examplepartner.com"),
    			},
    			Tags: pulumi.StringMap{
    				"Name": pulumi.String("Example Event Integration"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.AppConfig.EventIntegration("example", new()
        {
            Name = "example-name",
            Description = "Example Description",
            EventbridgeBus = "default",
            EventFilter = new Aws.AppConfig.Inputs.EventIntegrationEventFilterArgs
            {
                Source = "aws.partner/examplepartner.com",
            },
            Tags = 
            {
                { "Name", "Example Event Integration" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.appconfig.EventIntegration;
    import com.pulumi.aws.appconfig.EventIntegrationArgs;
    import com.pulumi.aws.appconfig.inputs.EventIntegrationEventFilterArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new EventIntegration("example", EventIntegrationArgs.builder()
                .name("example-name")
                .description("Example Description")
                .eventbridgeBus("default")
                .eventFilter(EventIntegrationEventFilterArgs.builder()
                    .source("aws.partner/examplepartner.com")
                    .build())
                .tags(Map.of("Name", "Example Event Integration"))
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:appconfig:EventIntegration
        properties:
          name: example-name
          description: Example Description
          eventbridgeBus: default
          eventFilter:
            source: aws.partner/examplepartner.com
          tags:
            Name: Example Event Integration
    

    Create EventIntegration Resource

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

    Constructor syntax

    new EventIntegration(name: string, args: EventIntegrationArgs, opts?: CustomResourceOptions);
    @overload
    def EventIntegration(resource_name: str,
                         args: EventIntegrationArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def EventIntegration(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         event_filter: Optional[EventIntegrationEventFilterArgs] = None,
                         eventbridge_bus: Optional[str] = None,
                         description: Optional[str] = None,
                         name: Optional[str] = None,
                         tags: Optional[Mapping[str, str]] = None)
    func NewEventIntegration(ctx *Context, name string, args EventIntegrationArgs, opts ...ResourceOption) (*EventIntegration, error)
    public EventIntegration(string name, EventIntegrationArgs args, CustomResourceOptions? opts = null)
    public EventIntegration(String name, EventIntegrationArgs args)
    public EventIntegration(String name, EventIntegrationArgs args, CustomResourceOptions options)
    
    type: aws:appconfig:EventIntegration
    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 EventIntegrationArgs
    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 EventIntegrationArgs
    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 EventIntegrationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EventIntegrationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EventIntegrationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var eventIntegrationResource = new Aws.AppConfig.EventIntegration("eventIntegrationResource", new()
    {
        EventFilter = new Aws.AppConfig.Inputs.EventIntegrationEventFilterArgs
        {
            Source = "string",
        },
        EventbridgeBus = "string",
        Description = "string",
        Name = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := appconfig.NewEventIntegration(ctx, "eventIntegrationResource", &appconfig.EventIntegrationArgs{
    	EventFilter: &appconfig.EventIntegrationEventFilterArgs{
    		Source: pulumi.String("string"),
    	},
    	EventbridgeBus: pulumi.String("string"),
    	Description:    pulumi.String("string"),
    	Name:           pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var eventIntegrationResource = new EventIntegration("eventIntegrationResource", EventIntegrationArgs.builder()
        .eventFilter(EventIntegrationEventFilterArgs.builder()
            .source("string")
            .build())
        .eventbridgeBus("string")
        .description("string")
        .name("string")
        .tags(Map.of("string", "string"))
        .build());
    
    event_integration_resource = aws.appconfig.EventIntegration("eventIntegrationResource",
        event_filter={
            "source": "string",
        },
        eventbridge_bus="string",
        description="string",
        name="string",
        tags={
            "string": "string",
        })
    
    const eventIntegrationResource = new aws.appconfig.EventIntegration("eventIntegrationResource", {
        eventFilter: {
            source: "string",
        },
        eventbridgeBus: "string",
        description: "string",
        name: "string",
        tags: {
            string: "string",
        },
    });
    
    type: aws:appconfig:EventIntegration
    properties:
        description: string
        eventFilter:
            source: string
        eventbridgeBus: string
        name: string
        tags:
            string: string
    

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

    EventFilter EventIntegrationEventFilter
    Block that defines the configuration information for the event filter. The Event Filter block is documented below.
    EventbridgeBus string
    EventBridge bus.
    Description string
    Description of the Event Integration.
    Name string
    Name of the Event Integration.
    Tags Dictionary<string, string>
    Tags to apply to the Event Integration. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    EventFilter EventIntegrationEventFilterArgs
    Block that defines the configuration information for the event filter. The Event Filter block is documented below.
    EventbridgeBus string
    EventBridge bus.
    Description string
    Description of the Event Integration.
    Name string
    Name of the Event Integration.
    Tags map[string]string
    Tags to apply to the Event Integration. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    eventFilter EventIntegrationEventFilter
    Block that defines the configuration information for the event filter. The Event Filter block is documented below.
    eventbridgeBus String
    EventBridge bus.
    description String
    Description of the Event Integration.
    name String
    Name of the Event Integration.
    tags Map<String,String>
    Tags to apply to the Event Integration. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    eventFilter EventIntegrationEventFilter
    Block that defines the configuration information for the event filter. The Event Filter block is documented below.
    eventbridgeBus string
    EventBridge bus.
    description string
    Description of the Event Integration.
    name string
    Name of the Event Integration.
    tags {[key: string]: string}
    Tags to apply to the Event Integration. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    event_filter EventIntegrationEventFilterArgs
    Block that defines the configuration information for the event filter. The Event Filter block is documented below.
    eventbridge_bus str
    EventBridge bus.
    description str
    Description of the Event Integration.
    name str
    Name of the Event Integration.
    tags Mapping[str, str]
    Tags to apply to the Event Integration. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    eventFilter Property Map
    Block that defines the configuration information for the event filter. The Event Filter block is documented below.
    eventbridgeBus String
    EventBridge bus.
    description String
    Description of the Event Integration.
    name String
    Name of the Event Integration.
    tags Map<String>
    Tags to apply to the Event Integration. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string
    ARN of the Event Integration.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN of the Event Integration.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the Event Integration.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN of the Event Integration.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN of the Event Integration.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the Event Integration.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing EventIntegration Resource

    Get an existing EventIntegration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: EventIntegrationState, opts?: CustomResourceOptions): EventIntegration
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            description: Optional[str] = None,
            event_filter: Optional[EventIntegrationEventFilterArgs] = None,
            eventbridge_bus: Optional[str] = None,
            name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None) -> EventIntegration
    func GetEventIntegration(ctx *Context, name string, id IDInput, state *EventIntegrationState, opts ...ResourceOption) (*EventIntegration, error)
    public static EventIntegration Get(string name, Input<string> id, EventIntegrationState? state, CustomResourceOptions? opts = null)
    public static EventIntegration get(String name, Output<String> id, EventIntegrationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    ARN of the Event Integration.
    Description string
    Description of the Event Integration.
    EventFilter EventIntegrationEventFilter
    Block that defines the configuration information for the event filter. The Event Filter block is documented below.
    EventbridgeBus string
    EventBridge bus.
    Name string
    Name of the Event Integration.
    Tags Dictionary<string, string>
    Tags to apply to the Event Integration. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN of the Event Integration.
    Description string
    Description of the Event Integration.
    EventFilter EventIntegrationEventFilterArgs
    Block that defines the configuration information for the event filter. The Event Filter block is documented below.
    EventbridgeBus string
    EventBridge bus.
    Name string
    Name of the Event Integration.
    Tags map[string]string
    Tags to apply to the Event Integration. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the Event Integration.
    description String
    Description of the Event Integration.
    eventFilter EventIntegrationEventFilter
    Block that defines the configuration information for the event filter. The Event Filter block is documented below.
    eventbridgeBus String
    EventBridge bus.
    name String
    Name of the Event Integration.
    tags Map<String,String>
    Tags to apply to the Event Integration. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN of the Event Integration.
    description string
    Description of the Event Integration.
    eventFilter EventIntegrationEventFilter
    Block that defines the configuration information for the event filter. The Event Filter block is documented below.
    eventbridgeBus string
    EventBridge bus.
    name string
    Name of the Event Integration.
    tags {[key: string]: string}
    Tags to apply to the Event Integration. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN of the Event Integration.
    description str
    Description of the Event Integration.
    event_filter EventIntegrationEventFilterArgs
    Block that defines the configuration information for the event filter. The Event Filter block is documented below.
    eventbridge_bus str
    EventBridge bus.
    name str
    Name of the Event Integration.
    tags Mapping[str, str]
    Tags to apply to the Event Integration. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the Event Integration.
    description String
    Description of the Event Integration.
    eventFilter Property Map
    Block that defines the configuration information for the event filter. The Event Filter block is documented below.
    eventbridgeBus String
    EventBridge bus.
    name String
    Name of the Event Integration.
    tags Map<String>
    Tags to apply to the Event Integration. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Supporting Types

    EventIntegrationEventFilter, EventIntegrationEventFilterArgs

    Source string
    Source of the events.
    Source string
    Source of the events.
    source String
    Source of the events.
    source string
    Source of the events.
    source str
    Source of the events.
    source String
    Source of the events.

    Import

    Using pulumi import, import Amazon AppIntegrations Event Integrations using the name. For example:

    $ pulumi import aws:appconfig/eventIntegration:EventIntegration example example-name
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.63.0 published on Wednesday, Dec 4, 2024 by Pulumi