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, 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.092Z")
 @Stability(value=Stable)
public class CfnWirelessGateway
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IoTWireless::WirelessGateway`.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnWirelessGateway.Builder A fluent builder for CfnWirelessGateway.
static interface	CfnWirelessGateway.LoRaWANGatewayProperty LoRaWAN wireless gateway 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
	CfnWirelessGateway(software.constructs.Construct scope, String id, CfnWirelessGatewayProps props) Create a new `AWS::IoTWireless::WirelessGateway`.
protected	CfnWirelessGateway(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnWirelessGateway(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The ARN of the wireless gateway created.
String	getAttrId() The ID of the wireless gateway created.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The description of the new resource.
String	getLastUplinkReceivedAt() The date and time when the most recent uplink was received.
Object	getLoRaWan() The gateway configuration information to use to create the wireless gateway.
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.
String	getThingArn() The ARN of the thing to associate with the wireless gateway.
String	getThingName() `AWS::IoTWireless::WirelessGateway.ThingName`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) The description of the new resource.
void	setLastUplinkReceivedAt(String value) The date and time when the most recent uplink was received.
void	setLoRaWan(CfnWirelessGateway.LoRaWANGatewayProperty value) The gateway configuration information to use to create the wireless gateway.
void	setLoRaWan(IResolvable value) The gateway configuration information to use to create the wireless gateway.
void	setName(String value) The name of the new resource.
void	setThingArn(String value) The ARN of the thing to associate with the wireless gateway.
void	setThingName(String value) `AWS::IoTWireless::WirelessGateway.ThingName`.

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

CfnWirelessGateway

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

CfnWirelessGateway

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

CfnWirelessGateway

@Stability(value=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 - - scoped id of the resource. This parameter is required.

props - - resource properties. 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 wireless gateway created.

getAttrId

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

The ID of the wireless gateway created.

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)
 @NotNull
public Object getLoRaWan()

The gateway configuration information to use to create the wireless gateway.

setLoRaWan

@Stability(value=Stable)
public void setLoRaWan(@NotNull
                                                CfnWirelessGateway.LoRaWANGatewayProperty value)

The gateway configuration information to use to create the wireless gateway.

setLoRaWan

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

The gateway configuration information to use to create the wireless gateway.

getDescription

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

The description of the new resource.

The maximum length is 2048 characters.

setDescription

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

The description of the new resource.

The maximum length is 2048 characters.

getLastUplinkReceivedAt

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

The date and time when the most recent uplink was received.

setLastUplinkReceivedAt

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

The date and time when the most recent uplink was received.

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.

getThingArn

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

The ARN of the thing to associate with the wireless gateway.

setThingArn

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

The ARN of the thing to associate with the wireless gateway.

getThingName

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

`AWS::IoTWireless::WirelessGateway.ThingName`.

setThingName

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

`AWS::IoTWireless::WirelessGateway.ThingName`.