Class CfnSenderId
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.smsvoice.CfnSenderId
- All Implemented Interfaces:
IEnvironmentAware,IInspectable,ITaggableV2,ISenderIdRef,software.amazon.jsii.JsiiSerializable,software.constructs.IConstruct,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
date="2025-11-10T13:40:15.469Z")
@Stability(Stable)
public class CfnSenderId
extends CfnResource
implements IInspectable, ISenderIdRef, ITaggableV2
Request a new sender ID that doesn't require registration.
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.smsvoice.*;
CfnSenderId cfnSenderId = CfnSenderId.Builder.create(this, "MyCfnSenderId")
.isoCountryCode("isoCountryCode")
.senderId("senderId")
// the properties below are optional
.deletionProtectionEnabled(false)
.tags(List.of(CfnTag.builder()
.key("key")
.value("value")
.build()))
.build();
- See Also:
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$DefaultNested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.services.smsvoice.ISenderIdRef
ISenderIdRef.Jsii$Default, ISenderIdRef.Jsii$ProxyNested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2
ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringThe CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCfnSenderId(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protectedCfnSenderId(software.amazon.jsii.JsiiObjectRef objRef) CfnSenderId(software.constructs.Construct scope, String id, CfnSenderIdProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe Amazon Resource Name of theSenderId.Tag Manager which manages the tags for this resource.By default this is set to false.The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.The sender ID string to request.A reference to a SenderId resource.getTags()An array of tags (key and value pairs) to associate with the sender ID.voidinspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties(Map<String, Object> props) voidBy default this is set to false.voidBy default this is set to false.voidsetIsoCountryCode(String value) The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.voidsetSenderId(String value) The sender ID string to request.voidAn array of tags (key and value pairs) to associate with the sender ID.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validatePropertiesMethods inherited from class software.amazon.awscdk.CfnRefElement
getRefMethods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdMethods inherited from class software.constructs.Construct
getNode, isConstructMethods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface software.constructs.IConstruct
getNodeMethods inherited from interface software.amazon.awscdk.IEnvironmentAware
getEnvMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnSenderId
protected CfnSenderId(software.amazon.jsii.JsiiObjectRef objRef) -
CfnSenderId
protected CfnSenderId(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnSenderId
@Stability(Stable) public CfnSenderId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnSenderIdProps props) - Parameters:
scope- Scope in which this resource is defined. This parameter is required.id- Construct identifier for this resource (unique in its scope). This parameter is required.props- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspectin interfaceIInspectable- 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:
renderPropertiesin classCfnResource- Parameters:
props- This parameter is required.
-
getAttrArn
The Amazon Resource Name of theSenderId. -
getCdkTagManager
Tag Manager which manages the tags for this resource.- Specified by:
getCdkTagManagerin interfaceITaggableV2
-
getCfnProperties
- Overrides:
getCfnPropertiesin classCfnResource
-
getSenderIdRef
A reference to a SenderId resource.- Specified by:
getSenderIdRefin interfaceISenderIdRef
-
getIsoCountryCode
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. -
setIsoCountryCode
The two-character code, in ISO 3166-1 alpha-2 format, for the country or region. -
getSenderId
The sender ID string to request. -
setSenderId
The sender ID string to request. -
getDeletionProtectionEnabled
By default this is set to false.Returns union: either
BooleanorIResolvable -
setDeletionProtectionEnabled
By default this is set to false. -
setDeletionProtectionEnabled
By default this is set to false. -
getTags
An array of tags (key and value pairs) to associate with the sender ID. -
setTags
An array of tags (key and value pairs) to associate with the sender ID.
-