Package software.amazon.awscdk.services.iotwireless

Class CfnServiceProfile

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.iotwireless.CfnServiceProfile
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:57.989Z") @Stability(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();

  • 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

    • CfnServiceProfile

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

    • CfnServiceProfile

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

    • CfnServiceProfile

      @Stability(Stable) public CfnServiceProfile(@NotNull 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(Stable) public CfnServiceProfile(@NotNull 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 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.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the service profile created.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of the service profile created.

    • getAttrLoRaWanChannelMask

      @Stability(Stable) @NotNull public String getAttrLoRaWanChannelMask()
      The ChannelMask value.

    • getAttrLoRaWanDevStatusReqFreq

      @Stability(Stable) @NotNull public Number getAttrLoRaWanDevStatusReqFreq()
      The DevStatusReqFreq value.

    • getAttrLoRaWanDlBucketSize

      @Stability(Stable) @NotNull public Number getAttrLoRaWanDlBucketSize()
      The DLBucketSize value.

    • getAttrLoRaWanDlRate

      @Stability(Stable) @NotNull public Number getAttrLoRaWanDlRate()
      The DLRate value.

    • getAttrLoRaWanDlRatePolicy

      @Stability(Stable) @NotNull public String getAttrLoRaWanDlRatePolicy()
      The DLRatePolicy value.

    • getAttrLoRaWanDrMax

      @Stability(Stable) @NotNull public Number getAttrLoRaWanDrMax()
      The DRMax value.

    • getAttrLoRaWanDrMin

      @Stability(Stable) @NotNull public Number getAttrLoRaWanDrMin()
      The DRMin value.

    • getAttrLoRaWanHrAllowed

      @Stability(Stable) @NotNull public IResolvable getAttrLoRaWanHrAllowed()
      The HRAllowed value that describes whether handover roaming is allowed.

    • getAttrLoRaWanMinGwDiversity

      @Stability(Stable) @NotNull public Number getAttrLoRaWanMinGwDiversity()
      The MinGwDiversity value.

    • getAttrLoRaWanNwkGeoLoc

      @Stability(Stable) @NotNull public IResolvable getAttrLoRaWanNwkGeoLoc()
      The NwkGeoLoc value.

    • getAttrLoRaWanPrAllowed

      @Stability(Stable) @NotNull public IResolvable getAttrLoRaWanPrAllowed()
      The PRAllowed value that describes whether passive roaming is allowed.

    • getAttrLoRaWanRaAllowed

      @Stability(Stable) @NotNull public IResolvable getAttrLoRaWanRaAllowed()
      The RAAllowed value that describes whether roaming activation is allowed.

    • getAttrLoRaWanReportDevStatusBattery

      @Stability(Stable) @NotNull public IResolvable getAttrLoRaWanReportDevStatusBattery()
      The ReportDevStatusBattery value.

    • getAttrLoRaWanReportDevStatusMargin

      @Stability(Stable) @NotNull public IResolvable getAttrLoRaWanReportDevStatusMargin()
      The ReportDevStatusMargin value.

    • getAttrLoRaWanResponse

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

    • getAttrLoRaWanTargetPer

      @Stability(Stable) @NotNull public Number getAttrLoRaWanTargetPer()
      The TargetPer value.

    • getAttrLoRaWanUlBucketSize

      @Stability(Stable) @NotNull public Number getAttrLoRaWanUlBucketSize()
      The UlBucketSize value.

    • getAttrLoRaWanUlRate

      @Stability(Stable) @NotNull public Number getAttrLoRaWanUlRate()
      The ULRate value.

    • getAttrLoRaWanUlRatePolicy

      @Stability(Stable) @NotNull public String getAttrLoRaWanUlRatePolicy()
      The ULRatePolicy value.

    • getCfnProperties

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

    • getTags

      @Stability(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(Stable) @Nullable public Object getLoRaWan()
      LoRaWAN service profile object.

    • setLoRaWan

      @Stability(Stable) public void setLoRaWan(@Nullable IResolvable value)
      LoRaWAN service profile object.

    • setLoRaWan

      @Stability(Stable) public void setLoRaWan(@Nullable CfnServiceProfile.LoRaWANServiceProfileProperty value)
      LoRaWAN service profile object.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the new resource.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the new resource.