CfnMember
- class aws_cdk.aws_managedblockchain.CfnMember(scope, id, *, member_configuration, invitation_id=None, network_configuration=None, network_id=None)
Bases:
CfnResource
A CloudFormation
AWS::ManagedBlockchain::Member
.Creates a member within a Managed Blockchain network.
Applies only to Hyperledger Fabric.
- CloudformationResource:
AWS::ManagedBlockchain::Member
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_managedblockchain as managedblockchain cfn_member = managedblockchain.CfnMember(self, "MyCfnMember", member_configuration=managedblockchain.CfnMember.MemberConfigurationProperty( name="name", # the properties below are optional description="description", member_framework_configuration=managedblockchain.CfnMember.MemberFrameworkConfigurationProperty( member_fabric_configuration=managedblockchain.CfnMember.MemberFabricConfigurationProperty( admin_password="adminPassword", admin_username="adminUsername" ) ) ), # the properties below are optional invitation_id="invitationId", network_configuration=managedblockchain.CfnMember.NetworkConfigurationProperty( framework="framework", framework_version="frameworkVersion", name="name", voting_policy=managedblockchain.CfnMember.VotingPolicyProperty( approval_threshold_policy=managedblockchain.CfnMember.ApprovalThresholdPolicyProperty( proposal_duration_in_hours=123, threshold_comparator="thresholdComparator", threshold_percentage=123 ) ), # the properties below are optional description="description", network_framework_configuration=managedblockchain.CfnMember.NetworkFrameworkConfigurationProperty( network_fabric_configuration=managedblockchain.CfnMember.NetworkFabricConfigurationProperty( edition="edition" ) ) ), network_id="networkId" )
Create a new
AWS::ManagedBlockchain::Member
.- Parameters:
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
member_configuration (
Union
[MemberConfigurationProperty
,Dict
[str
,Any
],IResolvable
]) – Configuration properties of the member.invitation_id (
Optional
[str
]) – The unique identifier of the invitation to join the network sent to the account that creates the member.network_configuration (
Union
[IResolvable
,NetworkConfigurationProperty
,Dict
[str
,Any
],None
]) – Configuration properties of the network to which the member belongs.network_id (
Optional
[str
]) – The unique identifier of the network to which the member belongs.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters:
path (
str
) – The path of the value to delete.- Return type:
None
- add_depends_on(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –value (
Any
) –
- See:
- Return type:
None
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str
) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters:
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Parameters:
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type:
None
- get_att(attribute_name)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str
) – The name of the attribute.- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –- See:
- Return type:
Any
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Return type:
None
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::ManagedBlockchain::Member'
- attr_member_id
The unique identifier of the member.
- CloudformationAttribute:
MemberId
- attr_network_id
The unique identifier of the network to which the member belongs.
- CloudformationAttribute:
NetworkId
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- invitation_id
The unique identifier of the invitation to join the network sent to the account that creates the member.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- member_configuration
Configuration properties of the member.
- network_configuration
Configuration properties of the network to which the member belongs.
- network_id
The unique identifier of the network to which the member belongs.
- node
The construct tree node associated with this construct.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
Static Methods
- classmethod is_cfn_element(x)
Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any
) –- Return type:
bool
- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(construct)
Check whether the given construct is a CfnResource.
- Parameters:
construct (
IConstruct
) –- Return type:
bool
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters:
x (
Any
) –- Return type:
bool
ApprovalThresholdPolicyProperty
- class CfnMember.ApprovalThresholdPolicyProperty(*, proposal_duration_in_hours=None, threshold_comparator=None, threshold_percentage=None)
Bases:
object
A policy type that defines the voting rules for the network.
The rules decide if a proposal is approved. Approval may be based on criteria such as the percentage of
YES
votes and the duration of the proposal. The policy applies to all proposals and is specified when the network is created.Applies only to Hyperledger Fabric.
- Parameters:
proposal_duration_in_hours (
Union
[int
,float
,None
]) – The duration from the time that a proposal is created until it expires. If members cast neither the required number ofYES
votes to approve the proposal nor the number ofNO
votes required to reject it before the duration expires, the proposal isEXPIRED
andProposalActions
aren’t carried out.threshold_comparator (
Optional
[str
]) – Determines whether the vote percentage must be greater than theThresholdPercentage
or must be greater than or equal to theThreholdPercentage
to be approved.threshold_percentage (
Union
[int
,float
,None
]) – The percentage of votes among all members that must beYES
for a proposal to be approved. For example, aThresholdPercentage
value of50
indicates 50%. TheThresholdComparator
determines the precise comparison. If aThresholdPercentage
value of50
is specified on a network with 10 members, along with aThresholdComparator
value ofGREATER_THAN
, this indicates that 6YES
votes are required for the proposal to be approved.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_managedblockchain as managedblockchain approval_threshold_policy_property = managedblockchain.CfnMember.ApprovalThresholdPolicyProperty( proposal_duration_in_hours=123, threshold_comparator="thresholdComparator", threshold_percentage=123 )
Attributes
- proposal_duration_in_hours
The duration from the time that a proposal is created until it expires.
If members cast neither the required number of
YES
votes to approve the proposal nor the number ofNO
votes required to reject it before the duration expires, the proposal isEXPIRED
andProposalActions
aren’t carried out.
- threshold_comparator
Determines whether the vote percentage must be greater than the
ThresholdPercentage
or must be greater than or equal to theThreholdPercentage
to be approved.
- threshold_percentage
The percentage of votes among all members that must be
YES
for a proposal to be approved.For example, a
ThresholdPercentage
value of50
indicates 50%. TheThresholdComparator
determines the precise comparison. If aThresholdPercentage
value of50
is specified on a network with 10 members, along with aThresholdComparator
value ofGREATER_THAN
, this indicates that 6YES
votes are required for the proposal to be approved.
MemberConfigurationProperty
- class CfnMember.MemberConfigurationProperty(*, name, description=None, member_framework_configuration=None)
Bases:
object
Configuration properties of the member.
Applies only to Hyperledger Fabric.
- Parameters:
name (
str
) – The name of the member.description (
Optional
[str
]) – An optional description of the member.member_framework_configuration (
Union
[IResolvable
,MemberFrameworkConfigurationProperty
,Dict
[str
,Any
],None
]) – Configuration properties of the blockchain framework relevant to the member.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_managedblockchain as managedblockchain member_configuration_property = managedblockchain.CfnMember.MemberConfigurationProperty( name="name", # the properties below are optional description="description", member_framework_configuration=managedblockchain.CfnMember.MemberFrameworkConfigurationProperty( member_fabric_configuration=managedblockchain.CfnMember.MemberFabricConfigurationProperty( admin_password="adminPassword", admin_username="adminUsername" ) ) )
Attributes
- description
An optional description of the member.
- member_framework_configuration
Configuration properties of the blockchain framework relevant to the member.
MemberFabricConfigurationProperty
- class CfnMember.MemberFabricConfigurationProperty(*, admin_password, admin_username)
Bases:
object
Configuration properties for Hyperledger Fabric for a member in a Managed Blockchain network that is using the Hyperledger Fabric framework.
- Parameters:
admin_password (
str
) – The password for the member’s initial administrative user. TheAdminPassword
must be at least 8 characters long and no more than 32 characters. It must contain at least one uppercase letter, one lowercase letter, and one digit. It cannot have a single quotation mark (‘), a double quotation marks (“), a forward slash(/), a backward slash(), @, or a space.admin_username (
str
) – The user name for the member’s initial administrative user.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_managedblockchain as managedblockchain member_fabric_configuration_property = managedblockchain.CfnMember.MemberFabricConfigurationProperty( admin_password="adminPassword", admin_username="adminUsername" )
Attributes
- admin_password
The password for the member’s initial administrative user.
The
AdminPassword
must be at least 8 characters long and no more than 32 characters. It must contain at least one uppercase letter, one lowercase letter, and one digit. It cannot have a single quotation mark (‘), a double quotation marks (“), a forward slash(/), a backward slash(), @, or a space.
- admin_username
The user name for the member’s initial administrative user.
MemberFrameworkConfigurationProperty
- class CfnMember.MemberFrameworkConfigurationProperty(*, member_fabric_configuration=None)
Bases:
object
Configuration properties relevant to a member for the blockchain framework that the Managed Blockchain network uses.
- Parameters:
member_fabric_configuration (
Union
[IResolvable
,MemberFabricConfigurationProperty
,Dict
[str
,Any
],None
]) – Configuration properties for Hyperledger Fabric.- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_managedblockchain as managedblockchain member_framework_configuration_property = managedblockchain.CfnMember.MemberFrameworkConfigurationProperty( member_fabric_configuration=managedblockchain.CfnMember.MemberFabricConfigurationProperty( admin_password="adminPassword", admin_username="adminUsername" ) )
Attributes
- member_fabric_configuration
Configuration properties for Hyperledger Fabric.
NetworkConfigurationProperty
- class CfnMember.NetworkConfigurationProperty(*, framework, framework_version, name, voting_policy, description=None, network_framework_configuration=None)
Bases:
object
Configuration properties of the network to which the member belongs.
- Parameters:
framework (
str
) – The blockchain framework that the network uses.framework_version (
str
) – The version of the blockchain framework that the network uses.name (
str
) – The name of the network.voting_policy (
Union
[IResolvable
,VotingPolicyProperty
,Dict
[str
,Any
]]) – The voting rules that the network uses to decide if a proposal is accepted.description (
Optional
[str
]) – Attributes of the blockchain framework for the network.network_framework_configuration (
Union
[IResolvable
,NetworkFrameworkConfigurationProperty
,Dict
[str
,Any
],None
]) – Configuration properties relevant to the network for the blockchain framework that the network uses.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_managedblockchain as managedblockchain network_configuration_property = managedblockchain.CfnMember.NetworkConfigurationProperty( framework="framework", framework_version="frameworkVersion", name="name", voting_policy=managedblockchain.CfnMember.VotingPolicyProperty( approval_threshold_policy=managedblockchain.CfnMember.ApprovalThresholdPolicyProperty( proposal_duration_in_hours=123, threshold_comparator="thresholdComparator", threshold_percentage=123 ) ), # the properties below are optional description="description", network_framework_configuration=managedblockchain.CfnMember.NetworkFrameworkConfigurationProperty( network_fabric_configuration=managedblockchain.CfnMember.NetworkFabricConfigurationProperty( edition="edition" ) ) )
Attributes
- description
Attributes of the blockchain framework for the network.
- framework
The blockchain framework that the network uses.
- framework_version
The version of the blockchain framework that the network uses.
- name
The name of the network.
- network_framework_configuration
Configuration properties relevant to the network for the blockchain framework that the network uses.
- voting_policy
The voting rules that the network uses to decide if a proposal is accepted.
NetworkFabricConfigurationProperty
- class CfnMember.NetworkFabricConfigurationProperty(*, edition)
Bases:
object
Hyperledger Fabric configuration properties for the network.
- Parameters:
edition (
str
) – The edition of Amazon Managed Blockchain that the network uses. Valid values arestandard
andstarter
. For more information, see Amazon Managed Blockchain Pricing- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_managedblockchain as managedblockchain network_fabric_configuration_property = managedblockchain.CfnMember.NetworkFabricConfigurationProperty( edition="edition" )
Attributes
- edition
The edition of Amazon Managed Blockchain that the network uses.
Valid values are
standard
andstarter
. For more information, see Amazon Managed Blockchain Pricing
NetworkFrameworkConfigurationProperty
- class CfnMember.NetworkFrameworkConfigurationProperty(*, network_fabric_configuration=None)
Bases:
object
Configuration properties relevant to the network for the blockchain framework that the network uses.
- Parameters:
network_fabric_configuration (
Union
[IResolvable
,NetworkFabricConfigurationProperty
,Dict
[str
,Any
],None
]) – Configuration properties for Hyperledger Fabric for a member in a Managed Blockchain network that is using the Hyperledger Fabric framework.- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_managedblockchain as managedblockchain network_framework_configuration_property = managedblockchain.CfnMember.NetworkFrameworkConfigurationProperty( network_fabric_configuration=managedblockchain.CfnMember.NetworkFabricConfigurationProperty( edition="edition" ) )
Attributes
- network_fabric_configuration
Configuration properties for Hyperledger Fabric for a member in a Managed Blockchain network that is using the Hyperledger Fabric framework.
VotingPolicyProperty
- class CfnMember.VotingPolicyProperty(*, approval_threshold_policy=None)
Bases:
object
The voting rules for the network to decide if a proposal is accepted.
Applies only to Hyperledger Fabric.
- Parameters:
approval_threshold_policy (
Union
[IResolvable
,ApprovalThresholdPolicyProperty
,Dict
[str
,Any
],None
]) – Defines the rules for the network for voting on proposals, such as the percentage ofYES
votes required for the proposal to be approved and the duration of the proposal. The policy applies to all proposals and is specified when the network is created.- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_managedblockchain as managedblockchain voting_policy_property = managedblockchain.CfnMember.VotingPolicyProperty( approval_threshold_policy=managedblockchain.CfnMember.ApprovalThresholdPolicyProperty( proposal_duration_in_hours=123, threshold_comparator="thresholdComparator", threshold_percentage=123 ) )
Attributes
- approval_threshold_policy
Defines the rules for the network for voting on proposals, such as the percentage of
YES
votes required for the proposal to be approved and the duration of the proposal.The policy applies to all proposals and is specified when the network is created.