software.amazon.awscdk.services.iotwireless

Class CfnPartnerAccount

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

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

A CloudFormation `AWS::IoTWireless::PartnerAccount`.

A partner account. If PartnerAccountId and PartnerType are null , returns all partner accounts.

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.*;
 CfnPartnerAccount cfnPartnerAccount = CfnPartnerAccount.Builder.create(this, "MyCfnPartnerAccount")
         .accountLinked(false)
         .fingerprint("fingerprint")
         .partnerAccountId("partnerAccountId")
         .partnerType("partnerType")
         .sidewalk(SidewalkAccountInfoProperty.builder()
                 .appServerPrivateKey("appServerPrivateKey")
                 .build())
         .sidewalkUpdate(SidewalkUpdateAccountProperty.builder()
                 .appServerPrivateKey("appServerPrivateKey")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnPartnerAccount.Builder A fluent builder for CfnPartnerAccount.
static interface	CfnPartnerAccount.SidewalkAccountInfoProperty Information about a Sidewalk account.
static interface	CfnPartnerAccount.SidewalkUpdateAccountProperty Sidewalk update.

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
	CfnPartnerAccount(software.constructs.Construct scope, String id) Create a new `AWS::IoTWireless::PartnerAccount`.
	CfnPartnerAccount(software.constructs.Construct scope, String id, CfnPartnerAccountProps props) Create a new `AWS::IoTWireless::PartnerAccount`.
protected	CfnPartnerAccount(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPartnerAccount(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
Object	getAccountLinked() `AWS::IoTWireless::PartnerAccount.AccountLinked`.
String	getAttrArn() The Amazon Resource Name (ARN) of the resource.
protected Map<String,Object>	getCfnProperties()
String	getFingerprint() `AWS::IoTWireless::PartnerAccount.Fingerprint`.
String	getPartnerAccountId() The ID of the partner account to update.
String	getPartnerType() `AWS::IoTWireless::PartnerAccount.PartnerType`.
Object	getSidewalk() The Sidewalk account credentials.
Object	getSidewalkUpdate() `AWS::IoTWireless::PartnerAccount.SidewalkUpdate`.
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	setAccountLinked(Boolean value) `AWS::IoTWireless::PartnerAccount.AccountLinked`.
void	setAccountLinked(IResolvable value) `AWS::IoTWireless::PartnerAccount.AccountLinked`.
void	setFingerprint(String value) `AWS::IoTWireless::PartnerAccount.Fingerprint`.
void	setPartnerAccountId(String value) The ID of the partner account to update.
void	setPartnerType(String value) `AWS::IoTWireless::PartnerAccount.PartnerType`.
void	setSidewalk(CfnPartnerAccount.SidewalkAccountInfoProperty value) The Sidewalk account credentials.
void	setSidewalk(IResolvable value) The Sidewalk account credentials.
void	setSidewalkUpdate(CfnPartnerAccount.SidewalkUpdateAccountProperty value) `AWS::IoTWireless::PartnerAccount.SidewalkUpdate`.
void	setSidewalkUpdate(IResolvable value) `AWS::IoTWireless::PartnerAccount.SidewalkUpdate`.

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

CfnPartnerAccount

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

CfnPartnerAccount

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

CfnPartnerAccount

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

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

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.

CfnPartnerAccount

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

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

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 Amazon Resource Name (ARN) of the resource.

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.

getAccountLinked

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

`AWS::IoTWireless::PartnerAccount.AccountLinked`.

setAccountLinked

@Stability(value=Stable)
public void setAccountLinked(@Nullable
                                                      Boolean value)

`AWS::IoTWireless::PartnerAccount.AccountLinked`.

setAccountLinked

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

`AWS::IoTWireless::PartnerAccount.AccountLinked`.

getFingerprint

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

`AWS::IoTWireless::PartnerAccount.Fingerprint`.

setFingerprint

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

`AWS::IoTWireless::PartnerAccount.Fingerprint`.

getPartnerAccountId

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

The ID of the partner account to update.

setPartnerAccountId

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

The ID of the partner account to update.

getPartnerType

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

`AWS::IoTWireless::PartnerAccount.PartnerType`.

setPartnerType

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

`AWS::IoTWireless::PartnerAccount.PartnerType`.

getSidewalk

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

The Sidewalk account credentials.

setSidewalk

@Stability(value=Stable)
public void setSidewalk(@Nullable
                                                 CfnPartnerAccount.SidewalkAccountInfoProperty value)

The Sidewalk account credentials.

setSidewalk

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

The Sidewalk account credentials.

getSidewalkUpdate

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

`AWS::IoTWireless::PartnerAccount.SidewalkUpdate`.

setSidewalkUpdate

@Stability(value=Stable)
public void setSidewalkUpdate(@Nullable
                                                       CfnPartnerAccount.SidewalkUpdateAccountProperty value)

`AWS::IoTWireless::PartnerAccount.SidewalkUpdate`.

setSidewalkUpdate

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

`AWS::IoTWireless::PartnerAccount.SidewalkUpdate`.