Package software.amazon.awscdk.services.iotwireless

Class CfnWirelessGateway

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.CfnWirelessGateway
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IWirelessGatewayRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:38.618Z") @Stability(Stable) public class CfnWirelessGateway extends CfnResource implements IInspectable, IWirelessGatewayRef, ITaggable
Provisions a wireless gateway.

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.*;
 CfnWirelessGateway cfnWirelessGateway = CfnWirelessGateway.Builder.create(this, "MyCfnWirelessGateway")
         .loRaWan(LoRaWANGatewayProperty.builder()
                 .gatewayEui("gatewayEui")
                 .rfRegion("rfRegion")
                 .build())
         // the properties below are optional
         .description("description")
         .lastUplinkReceivedAt("lastUplinkReceivedAt")
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .thingArn("thingArn")
         .thingName("thingName")
         .build();

See Also:

  • 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

    • CfnWirelessGateway

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

    • CfnWirelessGateway

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

    • CfnWirelessGateway

      @Stability(Stable) public CfnWirelessGateway(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnWirelessGatewayProps props)
      Create a new AWS::IoTWireless::WirelessGateway.

      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

    • arnForWirelessGateway

      @Stability(Stable) @NotNull public static String arnForWirelessGateway(@NotNull IWirelessGatewayRef resource)
      Parameters:
      resource - This parameter is required.

    • fromWirelessGatewayArn

      @Stability(Stable) @NotNull public static IWirelessGatewayRef fromWirelessGatewayArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IWirelessGatewayRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromWirelessGatewayId

      @Stability(Stable) @NotNull public static IWirelessGatewayRef fromWirelessGatewayId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String wirelessGatewayId)
      Creates a new IWirelessGatewayRef from a wirelessGatewayId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      wirelessGatewayId - This parameter is required.

    • isCfnWirelessGateway

      @Stability(Stable) @NotNull public static Boolean isCfnWirelessGateway(@NotNull Object x)
      Checks whether the given object is a CfnWirelessGateway.

      Parameters:
      x - This parameter is required.

    • 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 wireless gateway created.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of the wireless gateway created.

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getWirelessGatewayRef

      @Stability(Stable) @NotNull public WirelessGatewayReference getWirelessGatewayRef()
      A reference to a WirelessGateway resource.
      Specified by:
      getWirelessGatewayRef in interface IWirelessGatewayRef

    • getLoRaWan

      @Stability(Stable) @NotNull public Object getLoRaWan()
      The gateway configuration information to use to create the wireless gateway.

      Returns union: either IResolvable or CfnWirelessGateway.LoRaWANGatewayProperty

    • setLoRaWan

      @Stability(Stable) public void setLoRaWan(@NotNull IResolvable value)
      The gateway configuration information to use to create the wireless gateway.

    • setLoRaWan

      @Stability(Stable) public void setLoRaWan(@NotNull CfnWirelessGateway.LoRaWANGatewayProperty value)
      The gateway configuration information to use to create the wireless gateway.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the new resource.

    • setDescription

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

    • getLastUplinkReceivedAt

      @Stability(Stable) @Nullable public String getLastUplinkReceivedAt()
      The date and time when the most recent uplink was received.

    • setLastUplinkReceivedAt

      @Stability(Stable) public void setLastUplinkReceivedAt(@Nullable String value)
      The date and time when the most recent uplink was received.

    • 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.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The tags are an array of key-value pairs to attach to the specified resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The tags are an array of key-value pairs to attach to the specified resource.

    • getThingArn

      @Stability(Stable) @Nullable public String getThingArn()
      The ARN of the thing to associate with the wireless gateway.

    • setThingArn

      @Stability(Stable) public void setThingArn(@Nullable String value)
      The ARN of the thing to associate with the wireless gateway.

    • getThingName

      @Stability(Stable) @Nullable public String getThingName()
      The name of the thing associated with the wireless gateway.

    • setThingName

      @Stability(Stable) public void setThingName(@Nullable String value)
      The name of the thing associated with the wireless gateway.