1. Packages
  2. AWS Classic
  3. API Docs
  4. apprunner
  5. ObservabilityConfiguration

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

aws.apprunner.ObservabilityConfiguration

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

    Manages an App Runner Observability Configuration.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.apprunner.ObservabilityConfiguration("example", {
        observabilityConfigurationName: "example",
        traceConfiguration: {
            vendor: "AWSXRAY",
        },
        tags: {
            Name: "example-apprunner-observability-configuration",
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.apprunner.ObservabilityConfiguration("example",
        observability_configuration_name="example",
        trace_configuration=aws.apprunner.ObservabilityConfigurationTraceConfigurationArgs(
            vendor="AWSXRAY",
        ),
        tags={
            "Name": "example-apprunner-observability-configuration",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/apprunner"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := apprunner.NewObservabilityConfiguration(ctx, "example", &apprunner.ObservabilityConfigurationArgs{
    			ObservabilityConfigurationName: pulumi.String("example"),
    			TraceConfiguration: &apprunner.ObservabilityConfigurationTraceConfigurationArgs{
    				Vendor: pulumi.String("AWSXRAY"),
    			},
    			Tags: pulumi.StringMap{
    				"Name": pulumi.String("example-apprunner-observability-configuration"),
    			},
    		})
    		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.AppRunner.ObservabilityConfiguration("example", new()
        {
            ObservabilityConfigurationName = "example",
            TraceConfiguration = new Aws.AppRunner.Inputs.ObservabilityConfigurationTraceConfigurationArgs
            {
                Vendor = "AWSXRAY",
            },
            Tags = 
            {
                { "Name", "example-apprunner-observability-configuration" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.apprunner.ObservabilityConfiguration;
    import com.pulumi.aws.apprunner.ObservabilityConfigurationArgs;
    import com.pulumi.aws.apprunner.inputs.ObservabilityConfigurationTraceConfigurationArgs;
    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 ObservabilityConfiguration("example", ObservabilityConfigurationArgs.builder()
                .observabilityConfigurationName("example")
                .traceConfiguration(ObservabilityConfigurationTraceConfigurationArgs.builder()
                    .vendor("AWSXRAY")
                    .build())
                .tags(Map.of("Name", "example-apprunner-observability-configuration"))
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:apprunner:ObservabilityConfiguration
        properties:
          observabilityConfigurationName: example
          traceConfiguration:
            vendor: AWSXRAY
          tags:
            Name: example-apprunner-observability-configuration
    

    Create ObservabilityConfiguration Resource

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

    Constructor syntax

    new ObservabilityConfiguration(name: string, args: ObservabilityConfigurationArgs, opts?: CustomResourceOptions);
    @overload
    def ObservabilityConfiguration(resource_name: str,
                                   args: ObservabilityConfigurationArgs,
                                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def ObservabilityConfiguration(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   observability_configuration_name: Optional[str] = None,
                                   tags: Optional[Mapping[str, str]] = None,
                                   trace_configuration: Optional[ObservabilityConfigurationTraceConfigurationArgs] = None)
    func NewObservabilityConfiguration(ctx *Context, name string, args ObservabilityConfigurationArgs, opts ...ResourceOption) (*ObservabilityConfiguration, error)
    public ObservabilityConfiguration(string name, ObservabilityConfigurationArgs args, CustomResourceOptions? opts = null)
    public ObservabilityConfiguration(String name, ObservabilityConfigurationArgs args)
    public ObservabilityConfiguration(String name, ObservabilityConfigurationArgs args, CustomResourceOptions options)
    
    type: aws:apprunner:ObservabilityConfiguration
    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 ObservabilityConfigurationArgs
    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 ObservabilityConfigurationArgs
    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 ObservabilityConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ObservabilityConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ObservabilityConfigurationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var observabilityConfigurationResource = new Aws.AppRunner.ObservabilityConfiguration("observabilityConfigurationResource", new()
    {
        ObservabilityConfigurationName = "string",
        Tags = 
        {
            { "string", "string" },
        },
        TraceConfiguration = new Aws.AppRunner.Inputs.ObservabilityConfigurationTraceConfigurationArgs
        {
            Vendor = "string",
        },
    });
    
    example, err := apprunner.NewObservabilityConfiguration(ctx, "observabilityConfigurationResource", &apprunner.ObservabilityConfigurationArgs{
    	ObservabilityConfigurationName: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	TraceConfiguration: &apprunner.ObservabilityConfigurationTraceConfigurationArgs{
    		Vendor: pulumi.String("string"),
    	},
    })
    
    var observabilityConfigurationResource = new ObservabilityConfiguration("observabilityConfigurationResource", ObservabilityConfigurationArgs.builder()
        .observabilityConfigurationName("string")
        .tags(Map.of("string", "string"))
        .traceConfiguration(ObservabilityConfigurationTraceConfigurationArgs.builder()
            .vendor("string")
            .build())
        .build());
    
    observability_configuration_resource = aws.apprunner.ObservabilityConfiguration("observabilityConfigurationResource",
        observability_configuration_name="string",
        tags={
            "string": "string",
        },
        trace_configuration=aws.apprunner.ObservabilityConfigurationTraceConfigurationArgs(
            vendor="string",
        ))
    
    const observabilityConfigurationResource = new aws.apprunner.ObservabilityConfiguration("observabilityConfigurationResource", {
        observabilityConfigurationName: "string",
        tags: {
            string: "string",
        },
        traceConfiguration: {
            vendor: "string",
        },
    });
    
    type: aws:apprunner:ObservabilityConfiguration
    properties:
        observabilityConfigurationName: string
        tags:
            string: string
        traceConfiguration:
            vendor: string
    

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

    ObservabilityConfigurationName string
    Name of the observability configuration.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TraceConfiguration ObservabilityConfigurationTraceConfiguration
    Configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing. See Trace Configuration below for more details.
    ObservabilityConfigurationName string
    Name of the observability configuration.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TraceConfiguration ObservabilityConfigurationTraceConfigurationArgs
    Configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing. See Trace Configuration below for more details.
    observabilityConfigurationName String
    Name of the observability configuration.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    traceConfiguration ObservabilityConfigurationTraceConfiguration
    Configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing. See Trace Configuration below for more details.
    observabilityConfigurationName string
    Name of the observability configuration.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    traceConfiguration ObservabilityConfigurationTraceConfiguration
    Configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing. See Trace Configuration below for more details.
    observability_configuration_name str
    Name of the observability configuration.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    trace_configuration ObservabilityConfigurationTraceConfigurationArgs
    Configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing. See Trace Configuration below for more details.
    observabilityConfigurationName String
    Name of the observability configuration.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    traceConfiguration Property Map
    Configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing. See Trace Configuration below for more details.

    Outputs

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

    Arn string
    ARN of this observability configuration.
    Id string
    The provider-assigned unique ID for this managed resource.
    Latest bool
    Whether the observability configuration has the highest observability_configuration_revision among all configurations that share the same observability_configuration_name.
    ObservabilityConfigurationRevision int
    The revision of this observability configuration.
    Status string
    Current state of the observability configuration. An INACTIVE configuration revision has been deleted and can't be used. It is permanently removed some time after deletion.
    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 this observability configuration.
    Id string
    The provider-assigned unique ID for this managed resource.
    Latest bool
    Whether the observability configuration has the highest observability_configuration_revision among all configurations that share the same observability_configuration_name.
    ObservabilityConfigurationRevision int
    The revision of this observability configuration.
    Status string
    Current state of the observability configuration. An INACTIVE configuration revision has been deleted and can't be used. It is permanently removed some time after deletion.
    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 this observability configuration.
    id String
    The provider-assigned unique ID for this managed resource.
    latest Boolean
    Whether the observability configuration has the highest observability_configuration_revision among all configurations that share the same observability_configuration_name.
    observabilityConfigurationRevision Integer
    The revision of this observability configuration.
    status String
    Current state of the observability configuration. An INACTIVE configuration revision has been deleted and can't be used. It is permanently removed some time after deletion.
    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 this observability configuration.
    id string
    The provider-assigned unique ID for this managed resource.
    latest boolean
    Whether the observability configuration has the highest observability_configuration_revision among all configurations that share the same observability_configuration_name.
    observabilityConfigurationRevision number
    The revision of this observability configuration.
    status string
    Current state of the observability configuration. An INACTIVE configuration revision has been deleted and can't be used. It is permanently removed some time after deletion.
    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 this observability configuration.
    id str
    The provider-assigned unique ID for this managed resource.
    latest bool
    Whether the observability configuration has the highest observability_configuration_revision among all configurations that share the same observability_configuration_name.
    observability_configuration_revision int
    The revision of this observability configuration.
    status str
    Current state of the observability configuration. An INACTIVE configuration revision has been deleted and can't be used. It is permanently removed some time after deletion.
    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 this observability configuration.
    id String
    The provider-assigned unique ID for this managed resource.
    latest Boolean
    Whether the observability configuration has the highest observability_configuration_revision among all configurations that share the same observability_configuration_name.
    observabilityConfigurationRevision Number
    The revision of this observability configuration.
    status String
    Current state of the observability configuration. An INACTIVE configuration revision has been deleted and can't be used. It is permanently removed some time after deletion.
    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 ObservabilityConfiguration Resource

    Get an existing ObservabilityConfiguration 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?: ObservabilityConfigurationState, opts?: CustomResourceOptions): ObservabilityConfiguration
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            latest: Optional[bool] = None,
            observability_configuration_name: Optional[str] = None,
            observability_configuration_revision: Optional[int] = None,
            status: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            trace_configuration: Optional[ObservabilityConfigurationTraceConfigurationArgs] = None) -> ObservabilityConfiguration
    func GetObservabilityConfiguration(ctx *Context, name string, id IDInput, state *ObservabilityConfigurationState, opts ...ResourceOption) (*ObservabilityConfiguration, error)
    public static ObservabilityConfiguration Get(string name, Input<string> id, ObservabilityConfigurationState? state, CustomResourceOptions? opts = null)
    public static ObservabilityConfiguration get(String name, Output<String> id, ObservabilityConfigurationState 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 this observability configuration.
    Latest bool
    Whether the observability configuration has the highest observability_configuration_revision among all configurations that share the same observability_configuration_name.
    ObservabilityConfigurationName string
    Name of the observability configuration.
    ObservabilityConfigurationRevision int
    The revision of this observability configuration.
    Status string
    Current state of the observability configuration. An INACTIVE configuration revision has been deleted and can't be used. It is permanently removed some time after deletion.
    Tags Dictionary<string, string>
    Key-value map of resource tags. 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.

    TraceConfiguration ObservabilityConfigurationTraceConfiguration
    Configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing. See Trace Configuration below for more details.
    Arn string
    ARN of this observability configuration.
    Latest bool
    Whether the observability configuration has the highest observability_configuration_revision among all configurations that share the same observability_configuration_name.
    ObservabilityConfigurationName string
    Name of the observability configuration.
    ObservabilityConfigurationRevision int
    The revision of this observability configuration.
    Status string
    Current state of the observability configuration. An INACTIVE configuration revision has been deleted and can't be used. It is permanently removed some time after deletion.
    Tags map[string]string
    Key-value map of resource tags. 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.

    TraceConfiguration ObservabilityConfigurationTraceConfigurationArgs
    Configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing. See Trace Configuration below for more details.
    arn String
    ARN of this observability configuration.
    latest Boolean
    Whether the observability configuration has the highest observability_configuration_revision among all configurations that share the same observability_configuration_name.
    observabilityConfigurationName String
    Name of the observability configuration.
    observabilityConfigurationRevision Integer
    The revision of this observability configuration.
    status String
    Current state of the observability configuration. An INACTIVE configuration revision has been deleted and can't be used. It is permanently removed some time after deletion.
    tags Map<String,String>
    Key-value map of resource tags. 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.

    traceConfiguration ObservabilityConfigurationTraceConfiguration
    Configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing. See Trace Configuration below for more details.
    arn string
    ARN of this observability configuration.
    latest boolean
    Whether the observability configuration has the highest observability_configuration_revision among all configurations that share the same observability_configuration_name.
    observabilityConfigurationName string
    Name of the observability configuration.
    observabilityConfigurationRevision number
    The revision of this observability configuration.
    status string
    Current state of the observability configuration. An INACTIVE configuration revision has been deleted and can't be used. It is permanently removed some time after deletion.
    tags {[key: string]: string}
    Key-value map of resource tags. 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.

    traceConfiguration ObservabilityConfigurationTraceConfiguration
    Configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing. See Trace Configuration below for more details.
    arn str
    ARN of this observability configuration.
    latest bool
    Whether the observability configuration has the highest observability_configuration_revision among all configurations that share the same observability_configuration_name.
    observability_configuration_name str
    Name of the observability configuration.
    observability_configuration_revision int
    The revision of this observability configuration.
    status str
    Current state of the observability configuration. An INACTIVE configuration revision has been deleted and can't be used. It is permanently removed some time after deletion.
    tags Mapping[str, str]
    Key-value map of resource tags. 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.

    trace_configuration ObservabilityConfigurationTraceConfigurationArgs
    Configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing. See Trace Configuration below for more details.
    arn String
    ARN of this observability configuration.
    latest Boolean
    Whether the observability configuration has the highest observability_configuration_revision among all configurations that share the same observability_configuration_name.
    observabilityConfigurationName String
    Name of the observability configuration.
    observabilityConfigurationRevision Number
    The revision of this observability configuration.
    status String
    Current state of the observability configuration. An INACTIVE configuration revision has been deleted and can't be used. It is permanently removed some time after deletion.
    tags Map<String>
    Key-value map of resource tags. 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.

    traceConfiguration Property Map
    Configuration of the tracing feature within this observability configuration. If you don't specify it, App Runner doesn't enable tracing. See Trace Configuration below for more details.

    Supporting Types

    ObservabilityConfigurationTraceConfiguration, ObservabilityConfigurationTraceConfigurationArgs

    Vendor string
    Implementation provider chosen for tracing App Runner services. Valid values: AWSXRAY.
    Vendor string
    Implementation provider chosen for tracing App Runner services. Valid values: AWSXRAY.
    vendor String
    Implementation provider chosen for tracing App Runner services. Valid values: AWSXRAY.
    vendor string
    Implementation provider chosen for tracing App Runner services. Valid values: AWSXRAY.
    vendor str
    Implementation provider chosen for tracing App Runner services. Valid values: AWSXRAY.
    vendor String
    Implementation provider chosen for tracing App Runner services. Valid values: AWSXRAY.

    Import

    Using pulumi import, import App Runner Observability Configuration using the arn. For example:

    $ pulumi import aws:apprunner/observabilityConfiguration:ObservabilityConfiguration example arn:aws:apprunner:us-east-1:1234567890:observabilityconfiguration/example/1/d75bc7ea55b71e724fe5c23452fe22a1
    

    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

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi