Package com.pulumi.aws.chime

Class SdkvoiceSipRule

  • public class SdkvoiceSipRule
extends com.pulumi.resources.CustomResource
    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 <!--Start PulumiCodeChooser --> 
     
 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.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 SdkvoiceSipRule("example", SdkvoiceSipRuleArgs.builder()
             .name("example-sip-rule")
             .triggerType("RequestUriHostname")
             .triggerValue(example_voice_connector.outboundHostName())
             .targetApplications(SdkvoiceSipRuleTargetApplicationArgs.builder()
                 .priority(1)
                 .sipMediaApplicationId(example_sma.id())
                 .awsRegion("us-east-1")
                 .build())
             .build());
 
     }
 }
    <!--End PulumiCodeChooser --> ## Import Using `pulumi import`, import a ChimeSDKVoice SIP Rule using the `id`. For example: ```sh $ pulumi import aws:chime/sdkvoiceSipRule:SdkvoiceSipRule example abcdef123456 ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> disabled()  
      static SdkvoiceSipRule get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, SdkvoiceSipRuleState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.util.List<SdkvoiceSipRuleTargetApplication>> targetApplications()  
      com.pulumi.core.Output<java.lang.String> triggerType()  
      com.pulumi.core.Output<java.lang.String> triggerValue()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • SdkvoiceSipRule

        public SdkvoiceSipRule​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • SdkvoiceSipRule

        public SdkvoiceSipRule​(java.lang.String name,
                       SdkvoiceSipRuleArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • SdkvoiceSipRule

        public SdkvoiceSipRule​(java.lang.String name,
                       SdkvoiceSipRuleArgs args,
                       @Nullable
                       com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • disabled

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> disabled()
        Returns:
        Enables or disables a rule. You must disable rules before you can delete them.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        The name of the SIP rule.

      • targetApplications

        public com.pulumi.core.Output<java.util.List<SdkvoiceSipRuleTargetApplication>> targetApplications()
        Returns:
        List of SIP media applications with priority and AWS Region. Only one SIP application per AWS Region can be used. See `target_applications`.

      • triggerType

        public com.pulumi.core.Output<java.lang.String> triggerType()
        Returns:
        The type of trigger assigned to the SIP rule in `trigger_value`. Valid values are `RequestUriHostname` or `ToPhoneNumber`.

      • triggerValue

        public com.pulumi.core.Output<java.lang.String> triggerValue()
        Returns:
        If `trigger_type` is `RequestUriHostname`, the value can be the outbound host name of an Amazon Chime Voice Connector. If `trigger_type` 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. The following arguments are optional:

      • get

        public static SdkvoiceSipRule get​(java.lang.String name,
                                  com.pulumi.core.Output<java.lang.String> id,
                                  @Nullable
                                  SdkvoiceSipRuleState state,
                                  @Nullable
                                  com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.