Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. oam
  5. Sink
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

aws.oam.Sink

Explore with Pulumi AI

aws logo
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

    Resource for managing an AWS CloudWatch Observability Access Manager Sink.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.oam.Sink("example", {
    name: "ExampleSink",
    tags: {
        Env: "prod",
    },
});

    import pulumi
import pulumi_aws as aws

example = aws.oam.Sink("example",
    name="ExampleSink",
    tags={
        "Env": "prod",
    })

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/oam"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := oam.NewSink(ctx, "example", &oam.SinkArgs{
			Name: pulumi.String("ExampleSink"),
			Tags: pulumi.StringMap{
				"Env": pulumi.String("prod"),
			},
		})
		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.Oam.Sink("example", new()
    {
        Name = "ExampleSink",
        Tags = 
        {
            { "Env", "prod" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.oam.Sink;
import com.pulumi.aws.oam.SinkArgs;
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 Sink("example", SinkArgs.builder()
            .name("ExampleSink")
            .tags(Map.of("Env", "prod"))
            .build());

    }
}

    resources:
  example:
    type: aws:oam:Sink
    properties:
      name: ExampleSink
      tags:
        Env: prod

    Create Sink Resource

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

    Constructor syntax

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

@overload
def Sink(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         name: Optional[str] = None,
         tags: Optional[Mapping[str, str]] = None)
    func NewSink(ctx *Context, name string, args *SinkArgs, opts ...ResourceOption) (*Sink, error)
    public Sink(string name, SinkArgs? args = null, CustomResourceOptions? opts = null)
    public Sink(String name, SinkArgs args)
public Sink(String name, SinkArgs args, CustomResourceOptions options)

    type: aws:oam:Sink
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 SinkArgs
    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 SinkArgs
    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 SinkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SinkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SinkArgs
    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 sinkResource = new Aws.Oam.Sink("sinkResource", new()
{
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := oam.NewSink(ctx, "sinkResource", &oam.SinkArgs{
	Name: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var sinkResource = new Sink("sinkResource", SinkArgs.builder()
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

    sink_resource = aws.oam.Sink("sinkResource",
    name="string",
    tags={
        "string": "string",
    })

    const sinkResource = new aws.oam.Sink("sinkResource", {
    name: "string",
    tags: {
        string: "string",
    },
});

    type: aws:oam:Sink
properties:
    name: string
    tags:
        string: string

    Sink Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Sink resource accepts the following input properties:

    Name string

    Name for the sink.

    The following arguments are optional:

    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Name string

    Name for the sink.

    The following arguments are optional:

    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    name String

    Name for the sink.

    The following arguments are optional:

    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    name string

    Name for the sink.

    The following arguments are optional:

    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    name str

    Name for the sink.

    The following arguments are optional:

    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    name String

    Name for the sink.

    The following arguments are optional:

    tags Map<String>
    A map of tags to assign to the resource. 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 Sink resource produces the following output properties:

    Arn string
    ARN of the Sink.
    Id string
    The provider-assigned unique ID for this managed resource.
    SinkId string
    ID string that AWS generated as part of the sink ARN.
    TagsAll Dictionary<string, string>

    Deprecated: Please use tags instead.

    Arn string
    ARN of the Sink.
    Id string
    The provider-assigned unique ID for this managed resource.
    SinkId string
    ID string that AWS generated as part of the sink ARN.
    TagsAll map[string]string

    Deprecated: Please use tags instead.

    arn String
    ARN of the Sink.
    id String
    The provider-assigned unique ID for this managed resource.
    sinkId String
    ID string that AWS generated as part of the sink ARN.
    tagsAll Map<String,String>

    Deprecated: Please use tags instead.

    arn string
    ARN of the Sink.
    id string
    The provider-assigned unique ID for this managed resource.
    sinkId string
    ID string that AWS generated as part of the sink ARN.
    tagsAll {[key: string]: string}

    Deprecated: Please use tags instead.

    arn str
    ARN of the Sink.
    id str
    The provider-assigned unique ID for this managed resource.
    sink_id str
    ID string that AWS generated as part of the sink ARN.
    tags_all Mapping[str, str]

    Deprecated: Please use tags instead.

    arn String
    ARN of the Sink.
    id String
    The provider-assigned unique ID for this managed resource.
    sinkId String
    ID string that AWS generated as part of the sink ARN.
    tagsAll Map<String>

    Deprecated: Please use tags instead.

    Look up Existing Sink Resource

    Get an existing Sink 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?: SinkState, opts?: CustomResourceOptions): Sink
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        name: Optional[str] = None,
        sink_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> Sink
    func GetSink(ctx *Context, name string, id IDInput, state *SinkState, opts ...ResourceOption) (*Sink, error)
    public static Sink Get(string name, Input<string> id, SinkState? state, CustomResourceOptions? opts = null)
    public static Sink get(String name, Output<String> id, SinkState 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 Sink.
    Name string

    Name for the sink.

    The following arguments are optional:

    SinkId string
    ID string that AWS generated as part of the sink ARN.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. 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>

    Deprecated: Please use tags instead.

    Arn string
    ARN of the Sink.
    Name string

    Name for the sink.

    The following arguments are optional:

    SinkId string
    ID string that AWS generated as part of the sink ARN.
    Tags map[string]string
    A map of tags to assign to the resource. 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

    Deprecated: Please use tags instead.

    arn String
    ARN of the Sink.
    name String

    Name for the sink.

    The following arguments are optional:

    sinkId String
    ID string that AWS generated as part of the sink ARN.
    tags Map<String,String>
    A map of tags to assign to the resource. 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>

    Deprecated: Please use tags instead.

    arn string
    ARN of the Sink.
    name string

    Name for the sink.

    The following arguments are optional:

    sinkId string
    ID string that AWS generated as part of the sink ARN.
    tags {[key: string]: string}
    A map of tags to assign to the resource. 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}

    Deprecated: Please use tags instead.

    arn str
    ARN of the Sink.
    name str

    Name for the sink.

    The following arguments are optional:

    sink_id str
    ID string that AWS generated as part of the sink ARN.
    tags Mapping[str, str]
    A map of tags to assign to the resource. 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]

    Deprecated: Please use tags instead.

    arn String
    ARN of the Sink.
    name String

    Name for the sink.

    The following arguments are optional:

    sinkId String
    ID string that AWS generated as part of the sink ARN.
    tags Map<String>
    A map of tags to assign to the resource. 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>

    Deprecated: Please use tags instead.

    Import

    Using pulumi import, import CloudWatch Observability Access Manager Sink using the arn. For example:

    $ pulumi import aws:oam/sink:Sink example arn:aws:oam:us-west-2:123456789012:sink/sink-id

    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.54.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-aws