amazonka-managedblockchain-2.0: Amazon Managed Blockchain SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ManagedBlockChain.CreateNetwork

Description

Creates a new blockchain network using Amazon Managed Blockchain.

Applies only to Hyperledger Fabric.

Synopsis

Creating a Request

data CreateNetwork Source #

See: newCreateNetwork smart constructor.

Constructors

CreateNetwork' 

Fields

  • description :: Maybe Text

    An optional description for the network.

  • frameworkConfiguration :: Maybe NetworkFrameworkConfiguration

    Configuration properties of the blockchain framework relevant to the network configuration.

  • tags :: Maybe (HashMap Text Text)

    Tags to assign to the network. Each tag consists of a key and optional value.

    When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 tags added to each resource.

    For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.

  • clientRequestToken :: Text

    This is a unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an Amazon Web Services SDK or the Amazon Web Services CLI.

  • name :: Text

    The name of the network.

  • framework :: Framework

    The blockchain framework that the network uses.

  • frameworkVersion :: Text

    The version of the blockchain framework that the network uses.

  • votingPolicy :: VotingPolicy

    The voting rules used by the network to determine if a proposal is approved.

  • memberConfiguration :: MemberConfiguration

    Configuration properties for the first member within the network.

Instances

Instances details
ToJSON CreateNetwork Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateNetwork

ToHeaders CreateNetwork Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateNetwork

ToPath CreateNetwork Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateNetwork

ToQuery CreateNetwork Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateNetwork

AWSRequest CreateNetwork Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateNetwork

Associated Types

type AWSResponse CreateNetwork #

Generic CreateNetwork Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateNetwork

Associated Types

type Rep CreateNetwork :: Type -> Type #

Show CreateNetwork Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateNetwork

NFData CreateNetwork Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateNetwork

Methods

rnf :: CreateNetwork -> () #

Eq CreateNetwork Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateNetwork

Hashable CreateNetwork Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateNetwork

type AWSResponse CreateNetwork Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateNetwork

type Rep CreateNetwork Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateNetwork

newCreateNetwork Source #

Create a value of CreateNetwork with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateNetwork, createNetwork_description - An optional description for the network.

CreateNetwork, createNetwork_frameworkConfiguration - Configuration properties of the blockchain framework relevant to the network configuration.

CreateNetwork, createNetwork_tags - Tags to assign to the network. Each tag consists of a key and optional value.

When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 tags added to each resource.

For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.

$sel:clientRequestToken:CreateNetwork', createNetwork_clientRequestToken - This is a unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an Amazon Web Services SDK or the Amazon Web Services CLI.

CreateNetwork, createNetwork_name - The name of the network.

CreateNetwork, createNetwork_framework - The blockchain framework that the network uses.

CreateNetwork, createNetwork_frameworkVersion - The version of the blockchain framework that the network uses.

CreateNetwork, createNetwork_votingPolicy - The voting rules used by the network to determine if a proposal is approved.

$sel:memberConfiguration:CreateNetwork', createNetwork_memberConfiguration - Configuration properties for the first member within the network.

Request Lenses

createNetwork_description :: Lens' CreateNetwork (Maybe Text) Source #

An optional description for the network.

createNetwork_frameworkConfiguration :: Lens' CreateNetwork (Maybe NetworkFrameworkConfiguration) Source #

Configuration properties of the blockchain framework relevant to the network configuration.

createNetwork_tags :: Lens' CreateNetwork (Maybe (HashMap Text Text)) Source #

Tags to assign to the network. Each tag consists of a key and optional value.

When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 tags added to each resource.

For more information about tags, see Tagging Resources in the Amazon Managed Blockchain Ethereum Developer Guide, or Tagging Resources in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.

createNetwork_clientRequestToken :: Lens' CreateNetwork Text Source #

This is a unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once. This identifier is required only if you make a service request directly using an HTTP client. It is generated automatically if you use an Amazon Web Services SDK or the Amazon Web Services CLI.

createNetwork_name :: Lens' CreateNetwork Text Source #

The name of the network.

createNetwork_framework :: Lens' CreateNetwork Framework Source #

The blockchain framework that the network uses.

createNetwork_frameworkVersion :: Lens' CreateNetwork Text Source #

The version of the blockchain framework that the network uses.

createNetwork_votingPolicy :: Lens' CreateNetwork VotingPolicy Source #

The voting rules used by the network to determine if a proposal is approved.

createNetwork_memberConfiguration :: Lens' CreateNetwork MemberConfiguration Source #

Configuration properties for the first member within the network.

Destructuring the Response

data CreateNetworkResponse Source #

See: newCreateNetworkResponse smart constructor.

Constructors

CreateNetworkResponse' 

Fields

Instances

Instances details
Generic CreateNetworkResponse Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateNetwork

Associated Types

type Rep CreateNetworkResponse :: Type -> Type #

Read CreateNetworkResponse Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateNetwork

Show CreateNetworkResponse Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateNetwork

NFData CreateNetworkResponse Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateNetwork

Methods

rnf :: CreateNetworkResponse -> () #

Eq CreateNetworkResponse Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateNetwork

type Rep CreateNetworkResponse Source # 
Instance details

Defined in Amazonka.ManagedBlockChain.CreateNetwork

type Rep CreateNetworkResponse = D1 ('MetaData "CreateNetworkResponse" "Amazonka.ManagedBlockChain.CreateNetwork" "amazonka-managedblockchain-2.0-7ETEoTxOH0EDuOBkhEvxdC" 'False) (C1 ('MetaCons "CreateNetworkResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "memberId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "networkId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateNetworkResponse Source #

Create a value of CreateNetworkResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateNetworkResponse, createNetworkResponse_memberId - The unique identifier for the first member within the network.

CreateNetworkResponse, createNetworkResponse_networkId - The unique identifier for the network.

$sel:httpStatus:CreateNetworkResponse', createNetworkResponse_httpStatus - The response's http status code.

Response Lenses

createNetworkResponse_memberId :: Lens' CreateNetworkResponse (Maybe Text) Source #

The unique identifier for the first member within the network.

createNetworkResponse_networkId :: Lens' CreateNetworkResponse (Maybe Text) Source #

The unique identifier for the network.