software.amazon.awscdk.services.connect

Class CfnPhoneNumber

java.lang.Object

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

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:14.316Z")
public class CfnPhoneNumber
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Connect::PhoneNumber`.

Claims a phone number to the specified Amazon Connect instance.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnPhoneNumber.Builder A fluent builder for CfnPhoneNumber.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnPhoneNumber(Construct scope, java.lang.String id, CfnPhoneNumberProps props) Create a new `AWS::Connect::PhoneNumber`.
protected	CfnPhoneNumber(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPhoneNumber(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttrAddress() The phone number, in E.164 format.
java.lang.String	getAttrPhoneNumberArn() The Amazon Resource Name (ARN) of the phone number.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getCountryCode() The ISO country code.
java.lang.String	getDescription() The description of the phone number.
java.lang.String	getPrefix() The prefix of the phone number.
TagManager	getTags() The tags used to organize, track, or control access for this resource.
java.lang.String	getTargetArn() The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
java.lang.String	getType() The type of phone number.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setCountryCode(java.lang.String value) The ISO country code.
void	setDescription(java.lang.String value) The description of the phone number.
void	setPrefix(java.lang.String value) The prefix of the phone number.
void	setTargetArn(java.lang.String value) The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.
void	setType(java.lang.String value) The type of phone number.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnPhoneNumber

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

CfnPhoneNumber

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

CfnPhoneNumber

public CfnPhoneNumber(Construct scope,
                      java.lang.String id,
                      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 Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAddress

public java.lang.String getAttrAddress()

The phone number, in E.164 format.

getAttrPhoneNumberArn

public java.lang.String getAttrPhoneNumberArn()

The Amazon Resource Name (ARN) of the phone number.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

The tags used to organize, track, or control access for this resource.

getCountryCode

public java.lang.String getCountryCode()

The ISO country code.

setCountryCode

public void setCountryCode(java.lang.String value)

The ISO country code.

getTargetArn

public java.lang.String getTargetArn()

The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.

setTargetArn

public void setTargetArn(java.lang.String value)

The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.

getType

public java.lang.String getType()

The type of phone number.

setType

public void setType(java.lang.String value)

The type of phone number.

getDescription

public java.lang.String getDescription()

The description of the phone number.

setDescription

public void setDescription(java.lang.String value)

The description of the phone number.

getPrefix

public java.lang.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

public void setPrefix(java.lang.String value)

The prefix of the phone number. If provided, it must contain `+` as part of the country code.

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