Documentation
¶
Index ¶
- func CfnMember_CFN_RESOURCE_TYPE_NAME() *string
- func CfnMember_IsCfnElement(x interface{}) *bool
- func CfnMember_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnMember_IsConstruct(x interface{}) *bool
- func CfnNode_CFN_RESOURCE_TYPE_NAME() *string
- func CfnNode_IsCfnElement(x interface{}) *bool
- func CfnNode_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnNode_IsConstruct(x interface{}) *bool
- func NewCfnMember_Override(c CfnMember, scope constructs.Construct, id *string, props *CfnMemberProps)
- func NewCfnNode_Override(c CfnNode, scope constructs.Construct, id *string, props *CfnNodeProps)
- type CfnMember
- type CfnMemberProps
- type CfnMember_ApprovalThresholdPolicyProperty
- type CfnMember_MemberConfigurationProperty
- type CfnMember_MemberFabricConfigurationProperty
- type CfnMember_MemberFrameworkConfigurationProperty
- type CfnMember_NetworkConfigurationProperty
- type CfnMember_NetworkFabricConfigurationProperty
- type CfnMember_NetworkFrameworkConfigurationProperty
- type CfnMember_VotingPolicyProperty
- type CfnNode
- type CfnNodeProps
- type CfnNode_NodeConfigurationProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnMember_CFN_RESOURCE_TYPE_NAME ¶
func CfnMember_CFN_RESOURCE_TYPE_NAME() *string
func CfnMember_IsCfnElement ¶
func CfnMember_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnMember_IsCfnResource ¶
func CfnMember_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnMember_IsConstruct ¶
func CfnMember_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func CfnNode_CFN_RESOURCE_TYPE_NAME ¶
func CfnNode_CFN_RESOURCE_TYPE_NAME() *string
func CfnNode_IsCfnElement ¶
func CfnNode_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnNode_IsCfnResource ¶
func CfnNode_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource.
func CfnNode_IsConstruct ¶
func CfnNode_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead
func NewCfnMember_Override ¶
func NewCfnMember_Override(c CfnMember, scope constructs.Construct, id *string, props *CfnMemberProps)
Create a new `AWS::ManagedBlockchain::Member`.
func NewCfnNode_Override ¶
func NewCfnNode_Override(c CfnNode, scope constructs.Construct, id *string, props *CfnNodeProps)
Create a new `AWS::ManagedBlockchain::Node`.
Types ¶
type CfnMember ¶
type CfnMember interface {
awscdk.CfnResource
awscdk.IInspectable
AttrMemberId() *string
AttrNetworkId() *string
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreationStack() *[]*string
InvitationId() *string
SetInvitationId(val *string)
LogicalId() *string
MemberConfiguration() interface{}
SetMemberConfiguration(val interface{})
NetworkConfiguration() interface{}
SetNetworkConfiguration(val interface{})
NetworkId() *string
SetNetworkId(val *string)
Node() constructs.Node
Ref() *string
Stack() awscdk.Stack
UpdatedProperites() *map[string]interface{}
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::ManagedBlockchain::Member`.
Creates a member within a Managed Blockchain network.
Applies only to Hyperledger Fabric.
TODO: EXAMPLE
func NewCfnMember ¶
func NewCfnMember(scope constructs.Construct, id *string, props *CfnMemberProps) CfnMember
Create a new `AWS::ManagedBlockchain::Member`.
type CfnMemberProps ¶
type CfnMemberProps struct {
// Configuration properties of the member.
MemberConfiguration interface{} `json:"memberConfiguration"`
// The unique identifier of the invitation to join the network sent to the account that creates the member.
InvitationId *string `json:"invitationId"`
// Configuration properties of the network to which the member belongs.
NetworkConfiguration interface{} `json:"networkConfiguration"`
// The unique identifier of the network to which the member belongs.
NetworkId *string `json:"networkId"`
}
Properties for defining a `CfnMember`.
TODO: EXAMPLE
type CfnMember_ApprovalThresholdPolicyProperty ¶
type CfnMember_ApprovalThresholdPolicyProperty struct {
// 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` are not carried out.
ProposalDurationInHours *float64 `json:"proposalDurationInHours"`
// Determines whether the vote percentage must be greater than the `ThresholdPercentage` or must be greater than or equal to the `ThreholdPercentage` to be approved.
ThresholdComparator *string `json:"thresholdComparator"`
// 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.
ThresholdPercentage *float64 `json:"thresholdPercentage"`
}
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.
TODO: EXAMPLE
type CfnMember_MemberConfigurationProperty ¶
type CfnMember_MemberConfigurationProperty struct {
// The name of the member.
Name *string `json:"name"`
// An optional description of the member.
Description *string `json:"description"`
// Configuration properties of the blockchain framework relevant to the member.
MemberFrameworkConfiguration interface{} `json:"memberFrameworkConfiguration"`
}
Configuration properties of the member.
Applies only to Hyperledger Fabric.
TODO: EXAMPLE
type CfnMember_MemberFabricConfigurationProperty ¶
type CfnMember_MemberFabricConfigurationProperty struct {
// The password for the member's initial administrative user.
//
// The `AdminPassword` must be at least eight 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.
AdminPassword *string `json:"adminPassword"`
// The user name for the member's initial administrative user.
AdminUsername *string `json:"adminUsername"`
}
Configuration properties for Hyperledger Fabric for a member in a Managed Blockchain network using the Hyperledger Fabric framework.
TODO: EXAMPLE
type CfnMember_MemberFrameworkConfigurationProperty ¶
type CfnMember_MemberFrameworkConfigurationProperty struct {
// Configuration properties for Hyperledger Fabric.
MemberFabricConfiguration interface{} `json:"memberFabricConfiguration"`
}
Configuration properties relevant to a member for the blockchain framework that the Managed Blockchain network uses.
TODO: EXAMPLE
type CfnMember_NetworkConfigurationProperty ¶
type CfnMember_NetworkConfigurationProperty struct {
// The blockchain framework that the network uses.
Framework *string `json:"framework"`
// The version of the blockchain framework that the network uses.
FrameworkVersion *string `json:"frameworkVersion"`
// The name of the network.
Name *string `json:"name"`
// The voting rules for the network to decide if a proposal is accepted.
VotingPolicy interface{} `json:"votingPolicy"`
// Attributes of the blockchain framework for the network.
Description *string `json:"description"`
// Configuration properties relevant to the network for the blockchain framework that the network uses.
NetworkFrameworkConfiguration interface{} `json:"networkFrameworkConfiguration"`
}
Configuration properties of the network to which the member belongs.
TODO: EXAMPLE
type CfnMember_NetworkFabricConfigurationProperty ¶
type CfnMember_NetworkFabricConfigurationProperty struct {
// The edition of Amazon Managed Blockchain that the network uses.
//
// Valid values are `standard` and `starter` . For more information, see
Edition *string `json:"edition"`
}
Hyperledger Fabric configuration properties for the network.
TODO: EXAMPLE
type CfnMember_NetworkFrameworkConfigurationProperty ¶
type CfnMember_NetworkFrameworkConfigurationProperty struct {
// Configuration properties for Hyperledger Fabric for a member in a Managed Blockchain network using the Hyperledger Fabric framework.
NetworkFabricConfiguration interface{} `json:"networkFabricConfiguration"`
}
Configuration properties relevant to the network for the blockchain framework that the network uses.
TODO: EXAMPLE
type CfnMember_VotingPolicyProperty ¶
type CfnMember_VotingPolicyProperty struct {
// 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.
ApprovalThresholdPolicy interface{} `json:"approvalThresholdPolicy"`
}
The voting rules for the network to decide if a proposal is accepted.
Applies only to Hyperledger Fabric.
TODO: EXAMPLE
type CfnNode ¶
type CfnNode interface {
awscdk.CfnResource
awscdk.IInspectable
AttrArn() *string
AttrMemberId() *string
AttrNetworkId() *string
AttrNodeId() *string
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreationStack() *[]*string
LogicalId() *string
MemberId() *string
SetMemberId(val *string)
NetworkId() *string
SetNetworkId(val *string)
Node() constructs.Node
NodeConfiguration() interface{}
SetNodeConfiguration(val interface{})
Ref() *string
Stack() awscdk.Stack
UpdatedProperites() *map[string]interface{}
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OverrideLogicalId(newLogicalId *string)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
ToString() *string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::ManagedBlockchain::Node`.
Creates a node on the specified blockchain network.
Applies to Hyperledger Fabric and Ethereum.
TODO: EXAMPLE
func NewCfnNode ¶
func NewCfnNode(scope constructs.Construct, id *string, props *CfnNodeProps) CfnNode
Create a new `AWS::ManagedBlockchain::Node`.
type CfnNodeProps ¶
type CfnNodeProps struct {
// The unique identifier of the network for the node.
//
// Ethereum public networks have the following `NetworkId` s:
//
// - `n-ethereum-mainnet`
// - `n-ethereum-rinkeby`
// - `n-ethereum-ropsten`
NetworkId *string `json:"networkId"`
// Configuration properties of a peer node.
NodeConfiguration interface{} `json:"nodeConfiguration"`
// The unique identifier of the member to which the node belongs.
//
// Applies only to Hyperledger Fabric.
MemberId *string `json:"memberId"`
}
Properties for defining a `CfnNode`.
TODO: EXAMPLE
type CfnNode_NodeConfigurationProperty ¶
type CfnNode_NodeConfigurationProperty struct {
// The Availability Zone in which the node exists.
//
// Required for Ethereum nodes.
AvailabilityZone *string `json:"availabilityZone"`
// The Amazon Managed Blockchain instance type for the node.
InstanceType *string `json:"instanceType"`
}
Configuration properties of a peer node within a membership.
TODO: EXAMPLE