awsmanagedblockchain

package
v1.158.0-devpreview Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 27, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

README

AWS::ManagedBlockchain Construct Library

This module is part of the AWS Cloud Development Kit project.

import managedblockchain "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::ManagedBlockchain.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Documentation

Index

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

func CfnMember_IsCfnResource 

func CfnMember_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnMember_IsConstruct 

func CfnMember_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

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

func CfnNode_IsCfnResource 

func CfnNode_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource. Experimental.

func CfnNode_IsConstruct 

func CfnNode_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func NewCfnMember_Override 

func NewCfnMember_Override(c CfnMember, scope awscdk.Construct, id *string, props *CfnMemberProps)

Create a new `AWS::ManagedBlockchain::Member`.

func NewCfnNode_Override 

func NewCfnNode_Override(c CfnNode, scope awscdk.Construct, id *string, props *CfnNodeProps)

Create a new `AWS::ManagedBlockchain::Node`.

Types

type CfnMember 

type CfnMember interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The unique identifier of the member.
	AttrMemberId() *string
	// The unique identifier of the network to which the member belongs.
	AttrNetworkId() *string
	// Options for this resource, such as condition, update policy etc.
	// Experimental.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	// Experimental.
	CfnResourceType() *string
	// Returns: 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.
	// Experimental.
	CreationStack() *[]*string
	// The unique identifier of the invitation to join the network sent to the account that creates the member.
	InvitationId() *string
	SetInvitationId(val *string)
	// 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.
	// Experimental.
	LogicalId() *string
	// Configuration properties of the member.
	MemberConfiguration() interface{}
	SetMemberConfiguration(val interface{})
	// Configuration properties of the network to which the member belongs.
	NetworkConfiguration() interface{}
	SetNetworkConfiguration(val interface{})
	// The unique identifier of the network to which the member belongs.
	NetworkId() *string
	SetNetworkId(val *string)
	// The construct tree node associated with this construct.
	// Experimental.
	Node() awscdk.ConstructNode
	// 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 })`.
	// Experimental.
	Ref() *string
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	// Experimental.
	Stack() awscdk.Stack
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	// Experimental.
	UpdatedProperites() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	// Experimental.
	AddDeletionOverride(path *string)
	// 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.
	// Experimental.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: 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.
	//
	// Experimental.
	AddMetadata(key *string, value interface{})
	// Adds an override to the synthesized CloudFormation resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` 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,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`
	//
	// The `value` argument to `addOverride` 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.
	// Experimental.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	// Experimental.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	// Experimental.
	AddPropertyOverride(propertyPath *string, value interface{})
	// 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`).
	// Experimental.
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// 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.
	// Experimental.
	GetAtt(attributeName *string) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: 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.
	//
	// Experimental.
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	OnPrepare()
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	// Experimental.
	ShouldSynthesize() *bool
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	Synthesize(session awscdk.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	// Experimental.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	Validate() *[]*string
	// Experimental.
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::ManagedBlockchain::Member`.

Creates a member within a Managed Blockchain network.

Applies only to Hyperledger Fabric.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnMember := awscdk.Aws_managedblockchain.NewCfnMember(this, jsii.String("MyCfnMember"), &cfnMemberProps{
	memberConfiguration: &memberConfigurationProperty{
		name: jsii.String("name"),

		// the properties below are optional
		description: jsii.String("description"),
		memberFrameworkConfiguration: &memberFrameworkConfigurationProperty{
			memberFabricConfiguration: &memberFabricConfigurationProperty{
				adminPassword: jsii.String("adminPassword"),
				adminUsername: jsii.String("adminUsername"),
			},
		},
	},

	// the properties below are optional
	invitationId: jsii.String("invitationId"),
	networkConfiguration: &networkConfigurationProperty{
		framework: jsii.String("framework"),
		frameworkVersion: jsii.String("frameworkVersion"),
		name: jsii.String("name"),
		votingPolicy: &votingPolicyProperty{
			approvalThresholdPolicy: &approvalThresholdPolicyProperty{
				proposalDurationInHours: jsii.Number(123),
				thresholdComparator: jsii.String("thresholdComparator"),
				thresholdPercentage: jsii.Number(123),
			},
		},

		// the properties below are optional
		description: jsii.String("description"),
		networkFrameworkConfiguration: &networkFrameworkConfigurationProperty{
			networkFabricConfiguration: &networkFabricConfigurationProperty{
				edition: jsii.String("edition"),
			},
		},
	},
	networkId: jsii.String("networkId"),
})

func NewCfnMember 

func NewCfnMember(scope awscdk.Construct, id *string, props *CfnMemberProps) CfnMember

Create a new `AWS::ManagedBlockchain::Member`.

type CfnMemberProps 

type CfnMemberProps struct {
	// Configuration properties of the member.
	MemberConfiguration interface{} `field:"required" json:"memberConfiguration" yaml:"memberConfiguration"`
	// The unique identifier of the invitation to join the network sent to the account that creates the member.
	InvitationId *string `field:"optional" json:"invitationId" yaml:"invitationId"`
	// Configuration properties of the network to which the member belongs.
	NetworkConfiguration interface{} `field:"optional" json:"networkConfiguration" yaml:"networkConfiguration"`
	// The unique identifier of the network to which the member belongs.
	NetworkId *string `field:"optional" json:"networkId" yaml:"networkId"`
}

Properties for defining a `CfnMember`.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnMemberProps := &cfnMemberProps{
	memberConfiguration: &memberConfigurationProperty{
		name: jsii.String("name"),

		// the properties below are optional
		description: jsii.String("description"),
		memberFrameworkConfiguration: &memberFrameworkConfigurationProperty{
			memberFabricConfiguration: &memberFabricConfigurationProperty{
				adminPassword: jsii.String("adminPassword"),
				adminUsername: jsii.String("adminUsername"),
			},
		},
	},

	// the properties below are optional
	invitationId: jsii.String("invitationId"),
	networkConfiguration: &networkConfigurationProperty{
		framework: jsii.String("framework"),
		frameworkVersion: jsii.String("frameworkVersion"),
		name: jsii.String("name"),
		votingPolicy: &votingPolicyProperty{
			approvalThresholdPolicy: &approvalThresholdPolicyProperty{
				proposalDurationInHours: jsii.Number(123),
				thresholdComparator: jsii.String("thresholdComparator"),
				thresholdPercentage: jsii.Number(123),
			},
		},

		// the properties below are optional
		description: jsii.String("description"),
		networkFrameworkConfiguration: &networkFrameworkConfigurationProperty{
			networkFabricConfiguration: &networkFabricConfigurationProperty{
				edition: jsii.String("edition"),
			},
		},
	},
	networkId: jsii.String("networkId"),
}

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 `field:"optional" json:"proposalDurationInHours" yaml:"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 `field:"optional" json:"thresholdComparator" yaml:"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 `field:"optional" json:"thresholdPercentage" yaml:"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.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

approvalThresholdPolicyProperty := &approvalThresholdPolicyProperty{
	proposalDurationInHours: jsii.Number(123),
	thresholdComparator: jsii.String("thresholdComparator"),
	thresholdPercentage: jsii.Number(123),
}

type CfnMember_MemberConfigurationProperty 

type CfnMember_MemberConfigurationProperty struct {
	// The name of the member.
	Name *string `field:"required" json:"name" yaml:"name"`
	// An optional description of the member.
	Description *string `field:"optional" json:"description" yaml:"description"`
	// Configuration properties of the blockchain framework relevant to the member.
	MemberFrameworkConfiguration interface{} `field:"optional" json:"memberFrameworkConfiguration" yaml:"memberFrameworkConfiguration"`
}

Configuration properties of the member.

Applies only to Hyperledger Fabric.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

memberConfigurationProperty := &memberConfigurationProperty{
	name: jsii.String("name"),

	// the properties below are optional
	description: jsii.String("description"),
	memberFrameworkConfiguration: &memberFrameworkConfigurationProperty{
		memberFabricConfiguration: &memberFabricConfigurationProperty{
			adminPassword: jsii.String("adminPassword"),
			adminUsername: jsii.String("adminUsername"),
		},
	},
}

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 `field:"required" json:"adminPassword" yaml:"adminPassword"`
	// The user name for the member's initial administrative user.
	AdminUsername *string `field:"required" json:"adminUsername" yaml:"adminUsername"`
}

Configuration properties for Hyperledger Fabric for a member in a Managed Blockchain network using the Hyperledger Fabric framework.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

memberFabricConfigurationProperty := &memberFabricConfigurationProperty{
	adminPassword: jsii.String("adminPassword"),
	adminUsername: jsii.String("adminUsername"),
}

type CfnMember_MemberFrameworkConfigurationProperty 

type CfnMember_MemberFrameworkConfigurationProperty struct {
	// Configuration properties for Hyperledger Fabric.
	MemberFabricConfiguration interface{} `field:"optional" json:"memberFabricConfiguration" yaml:"memberFabricConfiguration"`
}

Configuration properties relevant to a member for the blockchain framework that the Managed Blockchain network uses.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

memberFrameworkConfigurationProperty := &memberFrameworkConfigurationProperty{
	memberFabricConfiguration: &memberFabricConfigurationProperty{
		adminPassword: jsii.String("adminPassword"),
		adminUsername: jsii.String("adminUsername"),
	},
}

type CfnMember_NetworkConfigurationProperty 

type CfnMember_NetworkConfigurationProperty struct {
	// The blockchain framework that the network uses.
	Framework *string `field:"required" json:"framework" yaml:"framework"`
	// The version of the blockchain framework that the network uses.
	FrameworkVersion *string `field:"required" json:"frameworkVersion" yaml:"frameworkVersion"`
	// The name of the network.
	Name *string `field:"required" json:"name" yaml:"name"`
	// The voting rules for the network to decide if a proposal is accepted.
	VotingPolicy interface{} `field:"required" json:"votingPolicy" yaml:"votingPolicy"`
	// Attributes of the blockchain framework for the network.
	Description *string `field:"optional" json:"description" yaml:"description"`
	// Configuration properties relevant to the network for the blockchain framework that the network uses.
	NetworkFrameworkConfiguration interface{} `field:"optional" json:"networkFrameworkConfiguration" yaml:"networkFrameworkConfiguration"`
}

Configuration properties of the network to which the member belongs.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

networkConfigurationProperty := &networkConfigurationProperty{
	framework: jsii.String("framework"),
	frameworkVersion: jsii.String("frameworkVersion"),
	name: jsii.String("name"),
	votingPolicy: &votingPolicyProperty{
		approvalThresholdPolicy: &approvalThresholdPolicyProperty{
			proposalDurationInHours: jsii.Number(123),
			thresholdComparator: jsii.String("thresholdComparator"),
			thresholdPercentage: jsii.Number(123),
		},
	},

	// the properties below are optional
	description: jsii.String("description"),
	networkFrameworkConfiguration: &networkFrameworkConfigurationProperty{
		networkFabricConfiguration: &networkFabricConfigurationProperty{
			edition: jsii.String("edition"),
		},
	},
}

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 `field:"required" json:"edition" yaml:"edition"`
}

Hyperledger Fabric configuration properties for the network.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

networkFabricConfigurationProperty := &networkFabricConfigurationProperty{
	edition: jsii.String("edition"),
}

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{} `field:"optional" json:"networkFabricConfiguration" yaml:"networkFabricConfiguration"`
}

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

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

networkFrameworkConfigurationProperty := &networkFrameworkConfigurationProperty{
	networkFabricConfiguration: &networkFabricConfigurationProperty{
		edition: jsii.String("edition"),
	},
}

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{} `field:"optional" json:"approvalThresholdPolicy" yaml:"approvalThresholdPolicy"`
}

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

Applies only to Hyperledger Fabric.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

votingPolicyProperty := &votingPolicyProperty{
	approvalThresholdPolicy: &approvalThresholdPolicyProperty{
		proposalDurationInHours: jsii.Number(123),
		thresholdComparator: jsii.String("thresholdComparator"),
		thresholdPercentage: jsii.Number(123),
	},
}

type CfnNode 

type CfnNode interface {
	awscdk.CfnResource
	awscdk.IInspectable
	// The Amazon Resource Name (ARN) of the node.
	AttrArn() *string
	// The unique identifier of the member in which the node is created.
	//
	// Applies only to Hyperledger Fabric.
	AttrMemberId() *string
	// The unique identifier of the network that the node is in.
	AttrNetworkId() *string
	// The unique identifier of the node.
	AttrNodeId() *string
	// Options for this resource, such as condition, update policy etc.
	// Experimental.
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	// AWS resource type.
	// Experimental.
	CfnResourceType() *string
	// Returns: 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.
	// Experimental.
	CreationStack() *[]*string
	// 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.
	// Experimental.
	LogicalId() *string
	// The unique identifier of the member to which the node belongs.
	//
	// Applies only to Hyperledger Fabric.
	MemberId() *string
	SetMemberId(val *string)
	// 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
	SetNetworkId(val *string)
	// The construct tree node associated with this construct.
	// Experimental.
	Node() awscdk.ConstructNode
	// Configuration properties of a peer node.
	NodeConfiguration() interface{}
	SetNodeConfiguration(val interface{})
	// 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 })`.
	// Experimental.
	Ref() *string
	// The stack in which this element is defined.
	//
	// CfnElements must be defined within a stack scope (directly or indirectly).
	// Experimental.
	Stack() awscdk.Stack
	// Return properties modified after initiation.
	//
	// Resources that expose mutable properties should override this function to
	// collect and return the properties object for this resource.
	// Experimental.
	UpdatedProperites() *map[string]interface{}
	// Syntactic sugar for `addOverride(path, undefined)`.
	// Experimental.
	AddDeletionOverride(path *string)
	// 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.
	// Experimental.
	AddDependsOn(target awscdk.CfnResource)
	// Add a value to the CloudFormation Resource Metadata.
	// See: 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.
	//
	// Experimental.
	AddMetadata(key *string, value interface{})
	// Adds an override to the synthesized CloudFormation resource.
	//
	// To add a
	// property override, either use `addPropertyOverride` or prefix `path` 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,
	// “`typescript
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
	// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
	// “`
	// would add the overrides
	// “`json
	// "Properties": {
	//    "GlobalSecondaryIndexes": [
	//      {
	//        "Projection": {
	//          "NonKeyAttributes": [ "myattribute" ]
	//          ...
	//        }
	//        ...
	//      },
	//      {
	//        "ProjectionType": "INCLUDE"
	//        ...
	//      },
	//    ]
	//    ...
	// }
	// “`
	//
	// The `value` argument to `addOverride` 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.
	// Experimental.
	AddOverride(path *string, value interface{})
	// Adds an override that deletes the value of a property from the resource definition.
	// Experimental.
	AddPropertyDeletionOverride(propertyPath *string)
	// Adds an override to a resource property.
	//
	// Syntactic sugar for `addOverride("Properties.<...>", value)`.
	// Experimental.
	AddPropertyOverride(propertyPath *string, value interface{})
	// 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`).
	// Experimental.
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	// 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.
	// Experimental.
	GetAtt(attributeName *string) awscdk.Reference
	// Retrieve a value value from the CloudFormation Resource Metadata.
	// See: 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.
	//
	// Experimental.
	GetMetadata(key *string) interface{}
	// Examines the CloudFormation resource and discloses attributes.
	Inspect(inspector awscdk.TreeInspector)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	OnPrepare()
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	OnValidate() *[]*string
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	Prepare()
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
	//
	// Returns: `true` if the resource should be included or `false` is the resource
	// should be omitted.
	// Experimental.
	ShouldSynthesize() *bool
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	Synthesize(session awscdk.ISynthesisSession)
	// Returns a string representation of this construct.
	//
	// Returns: a string representation of this resource.
	// Experimental.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	Validate() *[]*string
	// Experimental.
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::ManagedBlockchain::Node`.

Creates a node on the specified blockchain network.

Applies to Hyperledger Fabric and Ethereum.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnNode := awscdk.Aws_managedblockchain.NewCfnNode(this, jsii.String("MyCfnNode"), &cfnNodeProps{
	networkId: jsii.String("networkId"),
	nodeConfiguration: &nodeConfigurationProperty{
		availabilityZone: jsii.String("availabilityZone"),
		instanceType: jsii.String("instanceType"),
	},

	// the properties below are optional
	memberId: jsii.String("memberId"),
})

func NewCfnNode 

func NewCfnNode(scope awscdk.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 `field:"required" json:"networkId" yaml:"networkId"`
	// Configuration properties of a peer node.
	NodeConfiguration interface{} `field:"required" json:"nodeConfiguration" yaml:"nodeConfiguration"`
	// The unique identifier of the member to which the node belongs.
	//
	// Applies only to Hyperledger Fabric.
	MemberId *string `field:"optional" json:"memberId" yaml:"memberId"`
}

Properties for defining a `CfnNode`.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnNodeProps := &cfnNodeProps{
	networkId: jsii.String("networkId"),
	nodeConfiguration: &nodeConfigurationProperty{
		availabilityZone: jsii.String("availabilityZone"),
		instanceType: jsii.String("instanceType"),
	},

	// the properties below are optional
	memberId: jsii.String("memberId"),
}

type CfnNode_NodeConfigurationProperty 

type CfnNode_NodeConfigurationProperty struct {
	// The Availability Zone in which the node exists.
	//
	// Required for Ethereum nodes.
	AvailabilityZone *string `field:"required" json:"availabilityZone" yaml:"availabilityZone"`
	// The Amazon Managed Blockchain instance type for the node.
	InstanceType *string `field:"required" json:"instanceType" yaml:"instanceType"`
}

Configuration properties of a peer node within a membership.

Example: 

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

nodeConfigurationProperty := &nodeConfigurationProperty{
	availabilityZone: jsii.String("availabilityZone"),
	instanceType: jsii.String("instanceType"),
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.