CfnMemberPropsMixin

class aws_cdk.mixins_preview.aws_managedblockchain.mixins.CfnMemberPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a member within a Managed Blockchain network.

Applies only to Hyperledger Fabric.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-managedblockchain-member.html
CloudformationResource:: AWS::ManagedBlockchain::Member
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_managedblockchain import mixins as managedblockchain_mixins

cfn_member_props_mixin = managedblockchain_mixins.CfnMemberPropsMixin(managedblockchain_mixins.CfnMemberMixinProps(
    invitation_id="invitationId",
    member_configuration=managedblockchain_mixins.CfnMemberPropsMixin.MemberConfigurationProperty(
        description="description",
        member_framework_configuration=managedblockchain_mixins.CfnMemberPropsMixin.MemberFrameworkConfigurationProperty(
            member_fabric_configuration=managedblockchain_mixins.CfnMemberPropsMixin.MemberFabricConfigurationProperty(
                admin_password="adminPassword",
                admin_username="adminUsername"
            )
        ),
        name="name"
    ),
    network_configuration=managedblockchain_mixins.CfnMemberPropsMixin.NetworkConfigurationProperty(
        description="description",
        framework="framework",
        framework_version="frameworkVersion",
        name="name",
        network_framework_configuration=managedblockchain_mixins.CfnMemberPropsMixin.NetworkFrameworkConfigurationProperty(
            network_fabric_configuration=managedblockchain_mixins.CfnMemberPropsMixin.NetworkFabricConfigurationProperty(
                edition="edition"
            )
        ),
        voting_policy=managedblockchain_mixins.CfnMemberPropsMixin.VotingPolicyProperty(
            approval_threshold_policy=managedblockchain_mixins.CfnMemberPropsMixin.ApprovalThresholdPolicyProperty(
                proposal_duration_in_hours=123,
                threshold_comparator="thresholdComparator",
                threshold_percentage=123
            )
        )
    ),
    network_id="networkId"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::ManagedBlockchain::Member.

Parameters:

props (Union[CfnMemberMixinProps, 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:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['invitationId', 'memberConfiguration', 'networkConfiguration', 'networkId']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ApprovalThresholdPolicyProperty

class CfnMemberPropsMixin.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 of YES votes to approve the proposal nor the number of NO votes required to reject it before the duration expires, the proposal is EXPIRED and ProposalActions aren’t carried out.
threshold_comparator (Optional[str]) – Determines whether the vote percentage must be greater than the ThresholdPercentage or must be greater than or equal to the ThresholdPercentage to be approved.
threshold_percentage (Union[int, float, None]) – The percentage of votes among all members that must be YES for a proposal to be approved. For example, a ThresholdPercentage value of 50 indicates 50%. The ThresholdComparator determines the precise comparison. If a ThresholdPercentage value of 50 is specified on a network with 10 members, along with a ThresholdComparator value of GREATER_THAN , this indicates that 6 YES votes are required for the proposal to be approved.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-approvalthresholdpolicy.html

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_managedblockchain import mixins as managedblockchain_mixins

approval_threshold_policy_property = managedblockchain_mixins.CfnMemberPropsMixin.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 of NO votes required to reject it before the duration expires, the proposal is EXPIRED and ProposalActions aren’t carried out.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-approvalthresholdpolicy.html#cfn-managedblockchain-member-approvalthresholdpolicy-proposaldurationinhours

threshold_comparator

Determines whether the vote percentage must be greater than the ThresholdPercentage or must be greater than or equal to the ThresholdPercentage to be approved.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-approvalthresholdpolicy.html#cfn-managedblockchain-member-approvalthresholdpolicy-thresholdcomparator

threshold_percentage

The percentage of votes among all members that must be YES for a proposal to be approved.

For example, a ThresholdPercentage value of 50 indicates 50%. The ThresholdComparator determines the precise comparison. If a ThresholdPercentage value of 50 is specified on a network with 10 members, along with a ThresholdComparator value of GREATER_THAN , this indicates that 6 YES votes are required for the proposal to be approved.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-approvalthresholdpolicy.html#cfn-managedblockchain-member-approvalthresholdpolicy-thresholdpercentage

MemberConfigurationProperty

class CfnMemberPropsMixin.MemberConfigurationProperty(*, description=None, member_framework_configuration=None, name=None)

Bases: object

Configuration properties of the member.

Applies only to Hyperledger Fabric.

Parameters:

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.
name (Optional[str]) – The name of the member.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-memberconfiguration.html

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_managedblockchain import mixins as managedblockchain_mixins

member_configuration_property = managedblockchain_mixins.CfnMemberPropsMixin.MemberConfigurationProperty(
    description="description",
    member_framework_configuration=managedblockchain_mixins.CfnMemberPropsMixin.MemberFrameworkConfigurationProperty(
        member_fabric_configuration=managedblockchain_mixins.CfnMemberPropsMixin.MemberFabricConfigurationProperty(
            admin_password="adminPassword",
            admin_username="adminUsername"
        )
    ),
    name="name"
)

Attributes

description

An optional description of the member.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-memberconfiguration.html#cfn-managedblockchain-member-memberconfiguration-description

member_framework_configuration

Configuration properties of the blockchain framework relevant to the member.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-memberconfiguration.html#cfn-managedblockchain-member-memberconfiguration-memberframeworkconfiguration

name

The name of the member.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-memberconfiguration.html#cfn-managedblockchain-member-memberconfiguration-name

MemberFabricConfigurationProperty

class CfnMemberPropsMixin.MemberFabricConfigurationProperty(*, admin_password=None, admin_username=None)

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 (Optional[str]) – 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(),
admin_username (Optional[str]) – The user name for the member’s initial administrative user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-memberfabricconfiguration.html

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_managedblockchain import mixins as managedblockchain_mixins

member_fabric_configuration_property = managedblockchain_mixins.CfnMemberPropsMixin.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(),

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-memberfabricconfiguration.html#cfn-managedblockchain-member-memberfabricconfiguration-adminpassword

:: , or a space.

admin_username

The user name for the member’s initial administrative user.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-memberfabricconfiguration.html#cfn-managedblockchain-member-memberfabricconfiguration-adminusername

MemberFrameworkConfigurationProperty

class CfnMemberPropsMixin.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.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-memberframeworkconfiguration.html
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_managedblockchain import mixins as managedblockchain_mixins

member_framework_configuration_property = managedblockchain_mixins.CfnMemberPropsMixin.MemberFrameworkConfigurationProperty(
    member_fabric_configuration=managedblockchain_mixins.CfnMemberPropsMixin.MemberFabricConfigurationProperty(
        admin_password="adminPassword",
        admin_username="adminUsername"
    )
)

Attributes

member_fabric_configuration

Configuration properties for Hyperledger Fabric.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-memberframeworkconfiguration.html#cfn-managedblockchain-member-memberframeworkconfiguration-memberfabricconfiguration

NetworkConfigurationProperty

class CfnMemberPropsMixin.NetworkConfigurationProperty(*, description=None, framework=None, framework_version=None, name=None, network_framework_configuration=None, voting_policy=None)

Bases: object

Configuration properties of the network to which the member belongs.

Parameters:

description (Optional[str]) – Attributes of the blockchain framework for the network.
framework (Optional[str]) – The blockchain framework that the network uses.
framework_version (Optional[str]) – The version of the blockchain framework that the network uses.
name (Optional[str]) – The name of 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.
voting_policy (Union[IResolvable, VotingPolicyProperty, Dict[str, Any], None]) – The voting rules that the network uses to decide if a proposal is accepted.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-networkconfiguration.html

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_managedblockchain import mixins as managedblockchain_mixins

network_configuration_property = managedblockchain_mixins.CfnMemberPropsMixin.NetworkConfigurationProperty(
    description="description",
    framework="framework",
    framework_version="frameworkVersion",
    name="name",
    network_framework_configuration=managedblockchain_mixins.CfnMemberPropsMixin.NetworkFrameworkConfigurationProperty(
        network_fabric_configuration=managedblockchain_mixins.CfnMemberPropsMixin.NetworkFabricConfigurationProperty(
            edition="edition"
        )
    ),
    voting_policy=managedblockchain_mixins.CfnMemberPropsMixin.VotingPolicyProperty(
        approval_threshold_policy=managedblockchain_mixins.CfnMemberPropsMixin.ApprovalThresholdPolicyProperty(
            proposal_duration_in_hours=123,
            threshold_comparator="thresholdComparator",
            threshold_percentage=123
        )
    )
)

Attributes

description

Attributes of the blockchain framework for the network.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-networkconfiguration.html#cfn-managedblockchain-member-networkconfiguration-description

framework

The blockchain framework that the network uses.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-networkconfiguration.html#cfn-managedblockchain-member-networkconfiguration-framework

framework_version

The version of the blockchain framework that the network uses.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-networkconfiguration.html#cfn-managedblockchain-member-networkconfiguration-frameworkversion

name

The name of the network.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-networkconfiguration.html#cfn-managedblockchain-member-networkconfiguration-name

network_framework_configuration

Configuration properties relevant to the network for the blockchain framework that the network uses.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-networkconfiguration.html#cfn-managedblockchain-member-networkconfiguration-networkframeworkconfiguration

voting_policy

The voting rules that the network uses to decide if a proposal is accepted.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-networkconfiguration.html#cfn-managedblockchain-member-networkconfiguration-votingpolicy

NetworkFabricConfigurationProperty

class CfnMemberPropsMixin.NetworkFabricConfigurationProperty(*, edition=None)

Bases: object

Hyperledger Fabric configuration properties for the network.

Parameters:: edition (Optional[str]) – The edition of Amazon Managed Blockchain that the network uses. Valid values are standard and starter . For more information, see Amazon Managed Blockchain Pricing
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-networkfabricconfiguration.html
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_managedblockchain import mixins as managedblockchain_mixins

network_fabric_configuration_property = managedblockchain_mixins.CfnMemberPropsMixin.NetworkFabricConfigurationProperty(
    edition="edition"
)

Attributes

edition

The edition of Amazon Managed Blockchain that the network uses.

Valid values are standard and starter . For more information, see Amazon Managed Blockchain Pricing

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-networkfabricconfiguration.html#cfn-managedblockchain-member-networkfabricconfiguration-edition

NetworkFrameworkConfigurationProperty

class CfnMemberPropsMixin.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.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-networkframeworkconfiguration.html
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_managedblockchain import mixins as managedblockchain_mixins

network_framework_configuration_property = managedblockchain_mixins.CfnMemberPropsMixin.NetworkFrameworkConfigurationProperty(
    network_fabric_configuration=managedblockchain_mixins.CfnMemberPropsMixin.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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-networkframeworkconfiguration.html#cfn-managedblockchain-member-networkframeworkconfiguration-networkfabricconfiguration

VotingPolicyProperty

class CfnMemberPropsMixin.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 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.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-votingpolicy.html
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_managedblockchain import mixins as managedblockchain_mixins

voting_policy_property = managedblockchain_mixins.CfnMemberPropsMixin.VotingPolicyProperty(
    approval_threshold_policy=managedblockchain_mixins.CfnMemberPropsMixin.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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-managedblockchain-member-votingpolicy.html#cfn-managedblockchain-member-votingpolicy-approvalthresholdpolicy