1. Packages
  2. AWS
  3. API Docs
  4. chime
  5. VoiceConnectorLogging
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

aws.chime.VoiceConnectorLogging

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

    Adds a logging configuration for the specified Amazon Chime Voice Connector. The logging configuration specifies whether SIP message logs are enabled for sending to Amazon CloudWatch Logs.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const _default = new aws.chime.VoiceConnector("default", {
        name: "vc-name-test",
        requireEncryption: true,
    });
    const defaultVoiceConnectorLogging = new aws.chime.VoiceConnectorLogging("default", {
        enableSipLogs: true,
        enableMediaMetricLogs: true,
        voiceConnectorId: _default.id,
    });
    
    import pulumi
    import pulumi_aws as aws
    
    default = aws.chime.VoiceConnector("default",
        name="vc-name-test",
        require_encryption=True)
    default_voice_connector_logging = aws.chime.VoiceConnectorLogging("default",
        enable_sip_logs=True,
        enable_media_metric_logs=True,
        voice_connector_id=default.id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/chime"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := chime.NewVoiceConnector(ctx, "default", &chime.VoiceConnectorArgs{
    			Name:              pulumi.String("vc-name-test"),
    			RequireEncryption: pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = chime.NewVoiceConnectorLogging(ctx, "default", &chime.VoiceConnectorLoggingArgs{
    			EnableSipLogs:         pulumi.Bool(true),
    			EnableMediaMetricLogs: pulumi.Bool(true),
    			VoiceConnectorId:      _default.ID(),
    		})
    		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 @default = new Aws.Chime.VoiceConnector("default", new()
        {
            Name = "vc-name-test",
            RequireEncryption = true,
        });
    
        var defaultVoiceConnectorLogging = new Aws.Chime.VoiceConnectorLogging("default", new()
        {
            EnableSipLogs = true,
            EnableMediaMetricLogs = true,
            VoiceConnectorId = @default.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.chime.VoiceConnector;
    import com.pulumi.aws.chime.VoiceConnectorArgs;
    import com.pulumi.aws.chime.VoiceConnectorLogging;
    import com.pulumi.aws.chime.VoiceConnectorLoggingArgs;
    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 default_ = new VoiceConnector("default", VoiceConnectorArgs.builder()
                .name("vc-name-test")
                .requireEncryption(true)
                .build());
    
            var defaultVoiceConnectorLogging = new VoiceConnectorLogging("defaultVoiceConnectorLogging", VoiceConnectorLoggingArgs.builder()
                .enableSipLogs(true)
                .enableMediaMetricLogs(true)
                .voiceConnectorId(default_.id())
                .build());
    
        }
    }
    
    resources:
      default:
        type: aws:chime:VoiceConnector
        properties:
          name: vc-name-test
          requireEncryption: true
      defaultVoiceConnectorLogging:
        type: aws:chime:VoiceConnectorLogging
        name: default
        properties:
          enableSipLogs: true
          enableMediaMetricLogs: true
          voiceConnectorId: ${default.id}
    

    Create VoiceConnectorLogging Resource

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

    Constructor syntax

    new VoiceConnectorLogging(name: string, args: VoiceConnectorLoggingArgs, opts?: CustomResourceOptions);
    @overload
    def VoiceConnectorLogging(resource_name: str,
                              args: VoiceConnectorLoggingArgs,
                              opts: Optional[ResourceOptions] = None)
    
    @overload
    def VoiceConnectorLogging(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              voice_connector_id: Optional[str] = None,
                              enable_media_metric_logs: Optional[bool] = None,
                              enable_sip_logs: Optional[bool] = None)
    func NewVoiceConnectorLogging(ctx *Context, name string, args VoiceConnectorLoggingArgs, opts ...ResourceOption) (*VoiceConnectorLogging, error)
    public VoiceConnectorLogging(string name, VoiceConnectorLoggingArgs args, CustomResourceOptions? opts = null)
    public VoiceConnectorLogging(String name, VoiceConnectorLoggingArgs args)
    public VoiceConnectorLogging(String name, VoiceConnectorLoggingArgs args, CustomResourceOptions options)
    
    type: aws:chime:VoiceConnectorLogging
    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 VoiceConnectorLoggingArgs
    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 VoiceConnectorLoggingArgs
    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 VoiceConnectorLoggingArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VoiceConnectorLoggingArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VoiceConnectorLoggingArgs
    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 voiceConnectorLoggingResource = new Aws.Chime.VoiceConnectorLogging("voiceConnectorLoggingResource", new()
    {
        VoiceConnectorId = "string",
        EnableMediaMetricLogs = false,
        EnableSipLogs = false,
    });
    
    example, err := chime.NewVoiceConnectorLogging(ctx, "voiceConnectorLoggingResource", &chime.VoiceConnectorLoggingArgs{
    	VoiceConnectorId:      pulumi.String("string"),
    	EnableMediaMetricLogs: pulumi.Bool(false),
    	EnableSipLogs:         pulumi.Bool(false),
    })
    
    var voiceConnectorLoggingResource = new VoiceConnectorLogging("voiceConnectorLoggingResource", VoiceConnectorLoggingArgs.builder()
        .voiceConnectorId("string")
        .enableMediaMetricLogs(false)
        .enableSipLogs(false)
        .build());
    
    voice_connector_logging_resource = aws.chime.VoiceConnectorLogging("voiceConnectorLoggingResource",
        voice_connector_id="string",
        enable_media_metric_logs=False,
        enable_sip_logs=False)
    
    const voiceConnectorLoggingResource = new aws.chime.VoiceConnectorLogging("voiceConnectorLoggingResource", {
        voiceConnectorId: "string",
        enableMediaMetricLogs: false,
        enableSipLogs: false,
    });
    
    type: aws:chime:VoiceConnectorLogging
    properties:
        enableMediaMetricLogs: false
        enableSipLogs: false
        voiceConnectorId: string
    

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

    VoiceConnectorId string
    The Amazon Chime Voice Connector ID.
    EnableMediaMetricLogs bool
    When true, enables logging of detailed media metrics for Voice Connectors to Amazon CloudWatch logs.
    EnableSipLogs bool
    When true, enables SIP message logs for sending to Amazon CloudWatch Logs.
    VoiceConnectorId string
    The Amazon Chime Voice Connector ID.
    EnableMediaMetricLogs bool
    When true, enables logging of detailed media metrics for Voice Connectors to Amazon CloudWatch logs.
    EnableSipLogs bool
    When true, enables SIP message logs for sending to Amazon CloudWatch Logs.
    voiceConnectorId String
    The Amazon Chime Voice Connector ID.
    enableMediaMetricLogs Boolean
    When true, enables logging of detailed media metrics for Voice Connectors to Amazon CloudWatch logs.
    enableSipLogs Boolean
    When true, enables SIP message logs for sending to Amazon CloudWatch Logs.
    voiceConnectorId string
    The Amazon Chime Voice Connector ID.
    enableMediaMetricLogs boolean
    When true, enables logging of detailed media metrics for Voice Connectors to Amazon CloudWatch logs.
    enableSipLogs boolean
    When true, enables SIP message logs for sending to Amazon CloudWatch Logs.
    voice_connector_id str
    The Amazon Chime Voice Connector ID.
    enable_media_metric_logs bool
    When true, enables logging of detailed media metrics for Voice Connectors to Amazon CloudWatch logs.
    enable_sip_logs bool
    When true, enables SIP message logs for sending to Amazon CloudWatch Logs.
    voiceConnectorId String
    The Amazon Chime Voice Connector ID.
    enableMediaMetricLogs Boolean
    When true, enables logging of detailed media metrics for Voice Connectors to Amazon CloudWatch logs.
    enableSipLogs Boolean
    When true, enables SIP message logs for sending to Amazon CloudWatch Logs.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing VoiceConnectorLogging Resource

    Get an existing VoiceConnectorLogging 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?: VoiceConnectorLoggingState, opts?: CustomResourceOptions): VoiceConnectorLogging
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            enable_media_metric_logs: Optional[bool] = None,
            enable_sip_logs: Optional[bool] = None,
            voice_connector_id: Optional[str] = None) -> VoiceConnectorLogging
    func GetVoiceConnectorLogging(ctx *Context, name string, id IDInput, state *VoiceConnectorLoggingState, opts ...ResourceOption) (*VoiceConnectorLogging, error)
    public static VoiceConnectorLogging Get(string name, Input<string> id, VoiceConnectorLoggingState? state, CustomResourceOptions? opts = null)
    public static VoiceConnectorLogging get(String name, Output<String> id, VoiceConnectorLoggingState 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:
    EnableMediaMetricLogs bool
    When true, enables logging of detailed media metrics for Voice Connectors to Amazon CloudWatch logs.
    EnableSipLogs bool
    When true, enables SIP message logs for sending to Amazon CloudWatch Logs.
    VoiceConnectorId string
    The Amazon Chime Voice Connector ID.
    EnableMediaMetricLogs bool
    When true, enables logging of detailed media metrics for Voice Connectors to Amazon CloudWatch logs.
    EnableSipLogs bool
    When true, enables SIP message logs for sending to Amazon CloudWatch Logs.
    VoiceConnectorId string
    The Amazon Chime Voice Connector ID.
    enableMediaMetricLogs Boolean
    When true, enables logging of detailed media metrics for Voice Connectors to Amazon CloudWatch logs.
    enableSipLogs Boolean
    When true, enables SIP message logs for sending to Amazon CloudWatch Logs.
    voiceConnectorId String
    The Amazon Chime Voice Connector ID.
    enableMediaMetricLogs boolean
    When true, enables logging of detailed media metrics for Voice Connectors to Amazon CloudWatch logs.
    enableSipLogs boolean
    When true, enables SIP message logs for sending to Amazon CloudWatch Logs.
    voiceConnectorId string
    The Amazon Chime Voice Connector ID.
    enable_media_metric_logs bool
    When true, enables logging of detailed media metrics for Voice Connectors to Amazon CloudWatch logs.
    enable_sip_logs bool
    When true, enables SIP message logs for sending to Amazon CloudWatch Logs.
    voice_connector_id str
    The Amazon Chime Voice Connector ID.
    enableMediaMetricLogs Boolean
    When true, enables logging of detailed media metrics for Voice Connectors to Amazon CloudWatch logs.
    enableSipLogs Boolean
    When true, enables SIP message logs for sending to Amazon CloudWatch Logs.
    voiceConnectorId String
    The Amazon Chime Voice Connector ID.

    Import

    Using pulumi import, import Chime Voice Connector Logging using the voice_connector_id. For example:

    $ pulumi import aws:chime/voiceConnectorLogging:VoiceConnectorLogging default abcdef1ghij2klmno3pqr4
    

    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.60.0 published on Tuesday, Nov 19, 2024 by Pulumi