AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Managed Blockchain CreateNetwork API operation.

Syntax

New-MBCNetwork
-Name <String>
-Fabric_AdminPassword <String>
-Fabric_AdminUsername <String>
-ClientRequestToken <String>
-Description <String>
-MemberConfiguration_Description <String>
-Fabric_Edition <Edition>
-Cloudwatch_Enabled <Boolean>
-Framework <Framework>
-FrameworkVersion <String>
-MemberConfiguration_KmsKeyArn <String>
-MemberConfiguration_Name <String>
-ApprovalThresholdPolicy_ProposalDurationInHour <Int32>
-MemberConfiguration_Tag <Hashtable>
-Tag <Hashtable>
-ApprovalThresholdPolicy_ThresholdComparator <ThresholdComparator>
-ApprovalThresholdPolicy_ThresholdPercentage <Int32>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonManagedBlockchainConfig>

Description

Creates a new blockchain network using Amazon Managed Blockchain. Applies only to Hyperledger Fabric.

Parameters

-ApprovalThresholdPolicy_ProposalDurationInHour <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVotingPolicy_ApprovalThresholdPolicy_ProposalDurationInHours
-ApprovalThresholdPolicy_ThresholdComparator <ThresholdComparator>
Determines whether the vote percentage must be greater than the ThresholdPercentage or must be greater than or equal to the ThreholdPercentage to be approved.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVotingPolicy_ApprovalThresholdPolicy_ThresholdComparator
-ApprovalThresholdPolicy_ThresholdPercentage <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesVotingPolicy_ApprovalThresholdPolicy_ThresholdPercentage
-ClientConfig <AmazonManagedBlockchainConfig>
Amazon.PowerShell.Cmdlets.MBC.AmazonManagedBlockchainClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientRequestToken <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Cloudwatch_Enabled <Boolean>
Indicates whether logging is enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMemberConfiguration_LogPublishingConfiguration_Fabric_CaLogs_Cloudwatch_Enabled
-Description <String>
An optional description for the network.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Fabric_AdminPassword <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMemberConfiguration_FrameworkConfiguration_Fabric_AdminPassword
-Fabric_AdminUsername <String>
The user name for the member's initial administrative user.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMemberConfiguration_FrameworkConfiguration_Fabric_AdminUsername
-Fabric_Edition <Edition>
The edition of Amazon Managed Blockchain that the network uses. For more information, see Amazon Managed Blockchain Pricing.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFrameworkConfiguration_Fabric_Edition
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Framework <Framework>
The blockchain framework that the network uses.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-FrameworkVersion <String>
The version of the blockchain framework that the network uses.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-MemberConfiguration_Description <String>
An optional description of the member.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MemberConfiguration_KmsKeyArn <String>
The Amazon Resource Name (ARN) of the customer managed key in Key Management Service (KMS) to use for encryption at rest in the member. This parameter is inherited by any nodes that this member creates. For more information, see Encryption at Rest in the Amazon Managed Blockchain Hyperledger Fabric Developer Guide.Use one of the following options to specify this parameter:
  • Undefined or empty string - By default, use an KMS key that is owned and managed by Amazon Web Services on your behalf.
  • A valid symmetric customer managed KMS key - Use the specified KMS key in your account that you create, own, and manage.Amazon Managed Blockchain doesn't support asymmetric keys. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer Guide.The following is an example of a KMS key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MemberConfiguration_Name <String>
The name of the member.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-MemberConfiguration_Tag <Hashtable>
Tags assigned to the member. Tags consist 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMemberConfiguration_Tags
-Name <String>
The name of the network.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedBlockchain.Model.CreateNetworkResponse). Specifying the name of a property of type Amazon.ManagedBlockchain.Model.CreateNetworkResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
Tags to assign to the network. Each tag consists of a key and an optional value. You can specify multiple key-value pairs in a single request with an overall maximum of 50 tags allowed per 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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.ManagedBlockchain.Model.CreateNetworkResponse
This cmdlet returns an Amazon.ManagedBlockchain.Model.CreateNetworkResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z