software.amazon.awscdk.services.iotwireless

Class CfnServiceProfile

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.iotwireless.CfnServiceProfile

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.083Z")
 @Stability(value=Stable)
public class CfnServiceProfile
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IoTWireless::ServiceProfile`.

Creates a new service profile.

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.iotwireless.*;
 CfnServiceProfile cfnServiceProfile = CfnServiceProfile.Builder.create(this, "MyCfnServiceProfile")
         .loRaWan(LoRaWANServiceProfileProperty.builder()
                 .addGwMetadata(false)
                 .channelMask("channelMask")
                 .devStatusReqFreq(123)
                 .dlBucketSize(123)
                 .dlRate(123)
                 .dlRatePolicy("dlRatePolicy")
                 .drMax(123)
                 .drMin(123)
                 .hrAllowed(false)
                 .minGwDiversity(123)
                 .nwkGeoLoc(false)
                 .prAllowed(false)
                 .raAllowed(false)
                 .reportDevStatusBattery(false)
                 .reportDevStatusMargin(false)
                 .targetPer(123)
                 .ulBucketSize(123)
                 .ulRate(123)
                 .ulRatePolicy("ulRatePolicy")
                 .build())
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnServiceProfile.Builder A fluent builder for CfnServiceProfile.
static interface	CfnServiceProfile.LoRaWANServiceProfileProperty LoRaWANServiceProfile object.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnServiceProfile(software.constructs.Construct scope, String id) Create a new `AWS::IoTWireless::ServiceProfile`.
	CfnServiceProfile(software.constructs.Construct scope, String id, CfnServiceProfileProps props) Create a new `AWS::IoTWireless::ServiceProfile`.
protected	CfnServiceProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnServiceProfile(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The ARN of the service profile created.
String	getAttrId() The ID of the service profile created.
String	getAttrLoRaWanChannelMask() The ChannelMask value.
Number	getAttrLoRaWanDevStatusReqFreq() The DevStatusReqFreq value.
Number	getAttrLoRaWanDlBucketSize() The DLBucketSize value.
Number	getAttrLoRaWanDlRate() The DLRate value.
String	getAttrLoRaWanDlRatePolicy() The DLRatePolicy value.
Number	getAttrLoRaWanDrMax() The DRMax value.
Number	getAttrLoRaWanDrMin() The DRMin value.
IResolvable	getAttrLoRaWanHrAllowed() The HRAllowed value that describes whether handover roaming is allowed.
Number	getAttrLoRaWanMinGwDiversity() The MinGwDiversity value.
IResolvable	getAttrLoRaWanNwkGeoLoc() The NwkGeoLoc value.
IResolvable	getAttrLoRaWanPrAllowed() The PRAllowed value that describes whether passive roaming is allowed.
IResolvable	getAttrLoRaWanRaAllowed() The RAAllowed value that describes whether roaming activation is allowed.
IResolvable	getAttrLoRaWanReportDevStatusBattery() The ReportDevStatusBattery value.
IResolvable	getAttrLoRaWanReportDevStatusMargin() The ReportDevStatusMargin value.
IResolvable	getAttrLoRaWanResponse()
Number	getAttrLoRaWanTargetPer() The TargetPer value.
Number	getAttrLoRaWanUlBucketSize() The UlBucketSize value.
Number	getAttrLoRaWanUlRate() The ULRate value.
String	getAttrLoRaWanUlRatePolicy() The ULRatePolicy value.
protected Map<String,Object>	getCfnProperties()
Object	getLoRaWan() LoRaWAN service profile object.
String	getName() The name of the new resource.
TagManager	getTags() The tags are an array of key-value pairs to attach to the specified resource.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setLoRaWan(CfnServiceProfile.LoRaWANServiceProfileProperty value) LoRaWAN service profile object.
void	setLoRaWan(IResolvable value) LoRaWAN service profile object.
void	setName(String value) The name of the new resource.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnServiceProfile

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

CfnServiceProfile

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

CfnServiceProfile

@Stability(value=Stable)
public CfnServiceProfile(@NotNull
                                                  software.constructs.Construct scope,
                                                  @NotNull
                                                  String id,
                                                  @Nullable
                                                  CfnServiceProfileProps props)

Create a new `AWS::IoTWireless::ServiceProfile`.

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.

CfnServiceProfile

@Stability(value=Stable)
public CfnServiceProfile(@NotNull
                                                  software.constructs.Construct scope,
                                                  @NotNull
                                                  String id)

Create a new `AWS::IoTWireless::ServiceProfile`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The ARN of the service profile created.

getAttrId

@Stability(value=Stable)
 @NotNull
public String getAttrId()

The ID of the service profile created.

getAttrLoRaWanChannelMask

@Stability(value=Stable)
 @NotNull
public String getAttrLoRaWanChannelMask()

The ChannelMask value.

getAttrLoRaWanDevStatusReqFreq

@Stability(value=Stable)
 @NotNull
public Number getAttrLoRaWanDevStatusReqFreq()

The DevStatusReqFreq value.

getAttrLoRaWanDlBucketSize

@Stability(value=Stable)
 @NotNull
public Number getAttrLoRaWanDlBucketSize()

The DLBucketSize value.

getAttrLoRaWanDlRate

@Stability(value=Stable)
 @NotNull
public Number getAttrLoRaWanDlRate()

The DLRate value.

getAttrLoRaWanDlRatePolicy

@Stability(value=Stable)
 @NotNull
public String getAttrLoRaWanDlRatePolicy()

The DLRatePolicy value.

getAttrLoRaWanDrMax

@Stability(value=Stable)
 @NotNull
public Number getAttrLoRaWanDrMax()

The DRMax value.

getAttrLoRaWanDrMin

@Stability(value=Stable)
 @NotNull
public Number getAttrLoRaWanDrMin()

The DRMin value.

getAttrLoRaWanHrAllowed

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrLoRaWanHrAllowed()

The HRAllowed value that describes whether handover roaming is allowed.

getAttrLoRaWanMinGwDiversity

@Stability(value=Stable)
 @NotNull
public Number getAttrLoRaWanMinGwDiversity()

The MinGwDiversity value.

getAttrLoRaWanNwkGeoLoc

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrLoRaWanNwkGeoLoc()

The NwkGeoLoc value.

getAttrLoRaWanPrAllowed

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrLoRaWanPrAllowed()

The PRAllowed value that describes whether passive roaming is allowed.

getAttrLoRaWanRaAllowed

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrLoRaWanRaAllowed()

The RAAllowed value that describes whether roaming activation is allowed.

getAttrLoRaWanReportDevStatusBattery

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrLoRaWanReportDevStatusBattery()

The ReportDevStatusBattery value.

getAttrLoRaWanReportDevStatusMargin

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrLoRaWanReportDevStatusMargin()

The ReportDevStatusMargin value.

getAttrLoRaWanResponse

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrLoRaWanResponse()

getAttrLoRaWanTargetPer

@Stability(value=Stable)
 @NotNull
public Number getAttrLoRaWanTargetPer()

The TargetPer value.

getAttrLoRaWanUlBucketSize

@Stability(value=Stable)
 @NotNull
public Number getAttrLoRaWanUlBucketSize()

The UlBucketSize value.

getAttrLoRaWanUlRate

@Stability(value=Stable)
 @NotNull
public Number getAttrLoRaWanUlRate()

The ULRate value.

getAttrLoRaWanUlRatePolicy

@Stability(value=Stable)
 @NotNull
public String getAttrLoRaWanUlRatePolicy()

The ULRatePolicy value.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The tags are an array of key-value pairs to attach to the specified resource.

Tags can have a minimum of 0 and a maximum of 50 items.

getLoRaWan

@Stability(value=Stable)
 @Nullable
public Object getLoRaWan()

LoRaWAN service profile object.

setLoRaWan

@Stability(value=Stable)
public void setLoRaWan(@Nullable
                                                CfnServiceProfile.LoRaWANServiceProfileProperty value)

LoRaWAN service profile object.

setLoRaWan

@Stability(value=Stable)
public void setLoRaWan(@Nullable
                                                IResolvable value)

LoRaWAN service profile object.

getName

@Stability(value=Stable)
 @Nullable
public String getName()

The name of the new resource.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

The name of the new resource.