CfnPartnerAccountPropsMixin
- class aws_cdk.mixins_preview.aws_iotwireless.mixins.CfnPartnerAccountPropsMixin(props, *, strategy=None)
Bases:
MixinA partner account.
If
PartnerAccountIdandPartnerTypearenull, returns all partner accounts.- See:
- CloudformationResource:
AWS::IoTWireless::PartnerAccount
- Mixin:
true
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview import mixins from aws_cdk.mixins_preview.aws_iotwireless import mixins as iotwireless_mixins cfn_partner_account_props_mixin = iotwireless_mixins.CfnPartnerAccountPropsMixin(iotwireless_mixins.CfnPartnerAccountMixinProps( account_linked=False, partner_account_id="partnerAccountId", partner_type="partnerType", sidewalk=iotwireless_mixins.CfnPartnerAccountPropsMixin.SidewalkAccountInfoProperty( app_server_private_key="appServerPrivateKey" ), sidewalk_response=iotwireless_mixins.CfnPartnerAccountPropsMixin.SidewalkAccountInfoWithFingerprintProperty( amazon_id="amazonId", arn="arn", fingerprint="fingerprint" ), sidewalk_update=iotwireless_mixins.CfnPartnerAccountPropsMixin.SidewalkUpdateAccountProperty( app_server_private_key="appServerPrivateKey" ), tags=[CfnTag( key="key", value="value" )] ), strategy=mixins.PropertyMergeStrategy.OVERRIDE )
Create a mixin to apply properties to
AWS::IoTWireless::PartnerAccount.- Parameters:
props (
Union[CfnPartnerAccountMixinProps,Dict[str,Any]]) – L1 properties to apply.strategy (
Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE
Methods
- apply_to(construct)
Apply the mixin properties to the construct.
- Parameters:
construct (
IConstruct)- Return type:
- supports(construct)
Check if this mixin supports the given construct.
- Parameters:
construct (
IConstruct)- Return type:
bool
Attributes
- CFN_PROPERTY_KEYS = ['accountLinked', 'partnerAccountId', 'partnerType', 'sidewalk', 'sidewalkResponse', 'sidewalkUpdate', 'tags']
Static Methods
- classmethod is_mixin(x)
(experimental) Checks if
xis a Mixin.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsMixin.- Stability:
experimental
SidewalkAccountInfoProperty
- class CfnPartnerAccountPropsMixin.SidewalkAccountInfoProperty(*, app_server_private_key=None)
Bases:
objectInformation about a Sidewalk account.
- Parameters:
app_server_private_key (
Optional[str]) – The Sidewalk application server private key. The application server private key is a secret key, which you should handle in a similar way as you would an application password. You can protect the application server private key by storing the value in the AWS Secrets Manager and use the secretsmanager to reference this value.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_iotwireless import mixins as iotwireless_mixins sidewalk_account_info_property = iotwireless_mixins.CfnPartnerAccountPropsMixin.SidewalkAccountInfoProperty( app_server_private_key="appServerPrivateKey" )
Attributes
- app_server_private_key
The Sidewalk application server private key.
The application server private key is a secret key, which you should handle in a similar way as you would an application password. You can protect the application server private key by storing the value in the AWS Secrets Manager and use the secretsmanager to reference this value.
SidewalkAccountInfoWithFingerprintProperty
- class CfnPartnerAccountPropsMixin.SidewalkAccountInfoWithFingerprintProperty(*, amazon_id=None, arn=None, fingerprint=None)
Bases:
objectInformation about a Sidewalk account.
- Parameters:
amazon_id (
Optional[str]) – The Sidewalk Amazon ID.arn (
Optional[str]) – The Amazon Resource Name (ARN) of the resource.fingerprint (
Optional[str]) – The fingerprint of the Sidewalk application server private key.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_iotwireless import mixins as iotwireless_mixins sidewalk_account_info_with_fingerprint_property = iotwireless_mixins.CfnPartnerAccountPropsMixin.SidewalkAccountInfoWithFingerprintProperty( amazon_id="amazonId", arn="arn", fingerprint="fingerprint" )
Attributes
- amazon_id
The Sidewalk Amazon ID.
- arn
The Amazon Resource Name (ARN) of the resource.
- fingerprint
The fingerprint of the Sidewalk application server private key.
SidewalkUpdateAccountProperty
- class CfnPartnerAccountPropsMixin.SidewalkUpdateAccountProperty(*, app_server_private_key=None)
Bases:
objectSidewalk update.
- Parameters:
app_server_private_key (
Optional[str]) – The new Sidewalk application server private key.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk.mixins_preview.aws_iotwireless import mixins as iotwireless_mixins sidewalk_update_account_property = iotwireless_mixins.CfnPartnerAccountPropsMixin.SidewalkUpdateAccountProperty( app_server_private_key="appServerPrivateKey" )
Attributes
- app_server_private_key
The new Sidewalk application server private key.