CfnServiceProfile

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

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:37.115Z")
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 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.

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
	`CfnServiceProfile(Construct scope, java.lang.String id)` Create a new `AWS::IoTWireless::ServiceProfile`.
	`CfnServiceProfile(Construct scope, java.lang.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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttrArn()` The ARN of the service profile created.
`java.lang.String`	`getAttrId()` The ID of the service profile created.
`java.lang.String`	`getAttrLoRaWanChannelMask()` The ChannelMask value.
`java.lang.Number`	`getAttrLoRaWanDevStatusReqFreq()` The DevStatusReqFreq value.
`java.lang.Number`	`getAttrLoRaWanDlBucketSize()` The DLBucketSize value.
`java.lang.Number`	`getAttrLoRaWanDlRate()` The DLRate value.
`java.lang.String`	`getAttrLoRaWanDlRatePolicy()` The DLRatePolicy value.
`java.lang.Number`	`getAttrLoRaWanDrMax()` The DRMax value.
`java.lang.Number`	`getAttrLoRaWanDrMin()` The DRMin value.
`IResolvable`	`getAttrLoRaWanHrAllowed()` The HRAllowed value that describes whether handover roaming is allowed.
`java.lang.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()`
`java.lang.Number`	`getAttrLoRaWanTargetPer()` The TargetPer value.
`java.lang.Number`	`getAttrLoRaWanUlBucketSize()` The UlBucketSize value.
`java.lang.Number`	`getAttrLoRaWanUlRate()` The ULRate value.
`java.lang.String`	`getAttrLoRaWanUlRatePolicy()` The ULRatePolicy value.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.Object`	`getLoRaWan()` LoRaWAN service profile object.
`java.lang.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 java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setLoRaWan(CfnServiceProfile.LoRaWANServiceProfileProperty value)` LoRaWAN service profile object.
`void`	`setLoRaWan(IResolvable value)` LoRaWAN service profile object.
`void`	`setName(java.lang.String value)` The name of the new resource.

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
  - CfnServiceProfile
```
protected CfnServiceProfile(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnServiceProfile
```
protected CfnServiceProfile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnServiceProfile
```
public CfnServiceProfile(Construct scope,
                         java.lang.String id,
                         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
```
public CfnServiceProfile(Construct scope,
                         java.lang.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
```
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.
  - getAttrArn
```
public java.lang.String getAttrArn()
```
    The ARN of the service profile created.
  - getAttrId
```
public java.lang.String getAttrId()
```
    The ID of the service profile created.
  - getAttrLoRaWanChannelMask
```
public java.lang.String getAttrLoRaWanChannelMask()
```
    The ChannelMask value.
  - getAttrLoRaWanDevStatusReqFreq
```
public java.lang.Number getAttrLoRaWanDevStatusReqFreq()
```
    The DevStatusReqFreq value.
  - getAttrLoRaWanDlBucketSize
```
public java.lang.Number getAttrLoRaWanDlBucketSize()
```
    The DLBucketSize value.
  - getAttrLoRaWanDlRate
```
public java.lang.Number getAttrLoRaWanDlRate()
```
    The DLRate value.
  - getAttrLoRaWanDlRatePolicy
```
public java.lang.String getAttrLoRaWanDlRatePolicy()
```
    The DLRatePolicy value.
  - getAttrLoRaWanDrMax
```
public java.lang.Number getAttrLoRaWanDrMax()
```
    The DRMax value.
  - getAttrLoRaWanDrMin
```
public java.lang.Number getAttrLoRaWanDrMin()
```
    The DRMin value.
  - getAttrLoRaWanHrAllowed
```
public IResolvable getAttrLoRaWanHrAllowed()
```
    The HRAllowed value that describes whether handover roaming is allowed.
  - getAttrLoRaWanMinGwDiversity
```
public java.lang.Number getAttrLoRaWanMinGwDiversity()
```
    The MinGwDiversity value.
  - getAttrLoRaWanNwkGeoLoc
```
public IResolvable getAttrLoRaWanNwkGeoLoc()
```
    The NwkGeoLoc value.
  - getAttrLoRaWanPrAllowed
```
public IResolvable getAttrLoRaWanPrAllowed()
```
    The PRAllowed value that describes whether passive roaming is allowed.
  - getAttrLoRaWanRaAllowed
```
public IResolvable getAttrLoRaWanRaAllowed()
```
    The RAAllowed value that describes whether roaming activation is allowed.
  - getAttrLoRaWanReportDevStatusBattery
```
public IResolvable getAttrLoRaWanReportDevStatusBattery()
```
    The ReportDevStatusBattery value.
  - getAttrLoRaWanReportDevStatusMargin
```
public IResolvable getAttrLoRaWanReportDevStatusMargin()
```
    The ReportDevStatusMargin value.
  - getAttrLoRaWanResponse
```
public IResolvable getAttrLoRaWanResponse()
```
  - getAttrLoRaWanTargetPer
```
public java.lang.Number getAttrLoRaWanTargetPer()
```
    The TargetPer value.
  - getAttrLoRaWanUlBucketSize
```
public java.lang.Number getAttrLoRaWanUlBucketSize()
```
    The UlBucketSize value.
  - getAttrLoRaWanUlRate
```
public java.lang.Number getAttrLoRaWanUlRate()
```
    The ULRate value.
  - getAttrLoRaWanUlRatePolicy
```
public java.lang.String getAttrLoRaWanUlRatePolicy()
```
    The ULRatePolicy value.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
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
```
public java.lang.Object getLoRaWan()
```
    LoRaWAN service profile object.
  - setLoRaWan
```
public void setLoRaWan(IResolvable value)
```
    LoRaWAN service profile object.
  - setLoRaWan
```
public void setLoRaWan(CfnServiceProfile.LoRaWANServiceProfileProperty value)
```
    LoRaWAN service profile object.
  - getName
```
public java.lang.String getName()
```
    The name of the new resource.
  - setName
```
public void setName(java.lang.String value)
```
    The name of the new resource.

Class CfnServiceProfile

Nested Class Summary

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

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

Field Summary

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnServiceProfile

CfnServiceProfile

CfnServiceProfile

CfnServiceProfile

Method Detail

inspect

renderProperties

getAttrArn

getAttrId

getAttrLoRaWanChannelMask

getAttrLoRaWanDevStatusReqFreq

getAttrLoRaWanDlBucketSize

getAttrLoRaWanDlRate

getAttrLoRaWanDlRatePolicy

getAttrLoRaWanDrMax

getAttrLoRaWanDrMin

getAttrLoRaWanHrAllowed

getAttrLoRaWanMinGwDiversity

getAttrLoRaWanNwkGeoLoc

getAttrLoRaWanPrAllowed

getAttrLoRaWanRaAllowed

getAttrLoRaWanReportDevStatusBattery

getAttrLoRaWanReportDevStatusMargin

getAttrLoRaWanResponse

getAttrLoRaWanTargetPer

getAttrLoRaWanUlBucketSize

getAttrLoRaWanUlRate

getAttrLoRaWanUlRatePolicy

getCfnProperties

getTags

getLoRaWan

setLoRaWan

setLoRaWan

getName

setName