SdkvoiceSipRule class

A SIP rule associates your SIP media application with a phone number or a Request URI hostname. You can associate a SIP rule with more than one SIP media application. Each application then runs only that rule.

Example Usage

Basic Usage

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

const example = new aws.chime.SdkvoiceSipRule("example", {
    targetApplications: [{
        priority: 1,
        sipMediaApplicationId: example_sma.id,
        awsRegion: "us-east-1",
    }],
    name: "example-sip-rule",
    triggerType: "RequestUriHostname",
    triggerValue: example_voice_connector.outboundHostName,
});
import pulumi
import pulumi_aws as aws

example = aws.chime.SdkvoiceSipRule("example",
    target_applications=[{
        "priority": 1,
        "sip_media_application_id": example_sma["id"],
        "aws_region": "us-east-1",
    }],
    name="example-sip-rule",
    trigger_type="RequestUriHostname",
    trigger_value=example_voice_connector["outboundHostName"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Chime.SdkvoiceSipRule("example", new()
    {
        TargetApplications = new[]
        {
            new Aws.Chime.Inputs.SdkvoiceSipRuleTargetApplicationArgs
            {
                Priority = 1,
                SipMediaApplicationId = example_sma.Id,
                AwsRegion = "us-east-1",
            },
        },
        Name = "example-sip-rule",
        TriggerType = "RequestUriHostname",
        TriggerValue = example_voice_connector.OutboundHostName,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/chime"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := chime.NewSdkvoiceSipRule(ctx, "example", &chime.SdkvoiceSipRuleArgs{
			TargetApplications: chime.SdkvoiceSipRuleTargetApplicationArray{
				&chime.SdkvoiceSipRuleTargetApplicationArgs{
					Priority:              pulumi.Int(1),
					SipMediaApplicationId: pulumi.Any(example_sma.Id),
					AwsRegion:             pulumi.String("us-east-1"),
				},
			},
			Name:         pulumi.String("example-sip-rule"),
			TriggerType:  pulumi.String("RequestUriHostname"),
			TriggerValue: pulumi.Any(example_voice_connector.OutboundHostName),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_chime_sdkvoicesiprule" "example" {
  target_applications {
    priority                 = 1
    sip_media_application_id = example-sma.id
    aws_region               = "us-east-1"
  }
  name          = "example-sip-rule"
  trigger_type  = "RequestUriHostname"
  trigger_value = example-voice-connector.outboundHostName
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.chime.SdkvoiceSipRule;
import com.pulumi.aws.chime.SdkvoiceSipRuleArgs;
import com.pulumi.aws.chime.inputs.SdkvoiceSipRuleTargetApplicationArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 SdkvoiceSipRule("example", SdkvoiceSipRuleArgs.builder()
            .targetApplications(SdkvoiceSipRuleTargetApplicationArgs.builder()
                .priority(1)
                .sipMediaApplicationId(example_sma.id())
                .awsRegion("us-east-1")
                .build())
            .name("example-sip-rule")
            .triggerType("RequestUriHostname")
            .triggerValue(example_voice_connector.outboundHostName())
            .build());

    }
}
resources:
  example:
    type: aws:chime:SdkvoiceSipRule
    properties:
      targetApplications:
        - priority: 1
          sipMediaApplicationId: ${["example-sma"].id}
          awsRegion: us-east-1
      name: example-sip-rule
      triggerType: RequestUriHostname
      triggerValue: ${["example-voice-connector"].outboundHostName}

Import

Using pulumi import, import a ChimeSDKVoice SIP Rule using the id. For example:

$ pulumi import aws:chime/sdkvoiceSipRule:SdkvoiceSipRule example abcdef123456

Constructors

SdkvoiceSipRule(String name, {SdkvoiceSipRuleArgs? args, CustomResourceOptions? options})
Creates a new SdkvoiceSipRule. name The Pulumi resource name. args Arguments used to configure this SdkvoiceSipRule. The set of arguments for SdkvoiceSipRule. options Resource options controlling this resource's behavior.
SdkvoiceSipRule.reference(String urn)
Creates a typed reference to an existing SdkvoiceSipRule resource.

Properties

childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
disabled ↔ Output<bool?>
Enables or disables a rule. You must disable rules before you can delete them.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<String>
The name of the SIP rule.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
targetApplications ↔ Output<List<SdkvoiceSipRuleTargetApplication>>
List of SIP media applications with priority and AWS Region. Only one SIP application per AWS Region can be used. See targetApplications.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
triggerType ↔ Output<String>
The type of trigger assigned to the SIP rule in triggerValue. Valid values are RequestUriHostname or ToPhoneNumber.
latefinal
triggerValue ↔ Output<String>
If triggerType is RequestUriHostname, the value can be the outbound host name of an Amazon Chime Voice Connector. If triggerType is ToPhoneNumber, the value can be a customer-owned phone number in the E164 format. The Sip Media Application specified in the Sip Rule is triggered if the request URI in an incoming SIP request matches the RequestUriHostname, or if the "To" header in the incoming SIP request matches the ToPhoneNumber value.
latefinal
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {SdkvoiceSipRuleState? state, CustomResourceOptions? options}) → SdkvoiceSipRule
Gets an existing SdkvoiceSipRule resource's state with the given name and id.