Package software.amazon.awscdk.services.connect

Class CfnPhoneNumber

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.connect.CfnPhoneNumber
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:55.986Z") @Stability(Stable) public class CfnPhoneNumber extends CfnResource implements IInspectable
A CloudFormation AWS::Connect::PhoneNumber.

Claims a phone number to the specified Amazon Connect instance or traffic distribution group.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.connect.*;
 CfnPhoneNumber cfnPhoneNumber = CfnPhoneNumber.Builder.create(this, "MyCfnPhoneNumber")
         .countryCode("countryCode")
         .targetArn("targetArn")
         .type("type")
         // the properties below are optional
         .description("description")
         .prefix("prefix")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnPhoneNumber

      protected CfnPhoneNumber(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnPhoneNumber

      protected CfnPhoneNumber(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnPhoneNumber

      @Stability(Stable) public CfnPhoneNumber(@NotNull Construct scope, @NotNull String id, @NotNull CfnPhoneNumberProps props)
      Create a new AWS::Connect::PhoneNumber.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrAddress

      @Stability(Stable) @NotNull public String getAttrAddress()
      The phone number, in E.164 format.

    • getAttrPhoneNumberArn

      @Stability(Stable) @NotNull public String getAttrPhoneNumberArn()
      The Amazon Resource Name (ARN) of the phone number.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The tags used to organize, track, or control access for this resource.

      For example, { "tags": {"key1":"value1", "key2":"value2"} }.

    • getCountryCode

      @Stability(Stable) @NotNull public String getCountryCode()
      The ISO country code.

    • setCountryCode

      @Stability(Stable) public void setCountryCode(@NotNull String value)
      The ISO country code.

    • getTargetArn

      @Stability(Stable) @NotNull public String getTargetArn()
      The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution group that phone numbers are claimed to.

    • setTargetArn

      @Stability(Stable) public void setTargetArn(@NotNull String value)
      The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution group that phone numbers are claimed to.

    • getType

      @Stability(Stable) @NotNull public String getType()
      The type of phone number.

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      The type of phone number.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the phone number.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the phone number.

    • getPrefix

      @Stability(Stable) @Nullable public String getPrefix()
      The prefix of the phone number. If provided, it must contain + as part of the country code.

      Pattern : ^\\+[0-9]{1,15}

    • setPrefix

      @Stability(Stable) public void setPrefix(@Nullable String value)
      The prefix of the phone number. If provided, it must contain + as part of the country code.

      Pattern : ^\\+[0-9]{1,15}