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 CreateMember API operation.

Syntax

New-MBCMember
-MemberConfiguration_Name <String>
-Fabric_AdminPassword <String>
-Fabric_AdminUsername <String>
-ClientRequestToken <String>
-MemberConfiguration_Description <String>
-Cloudwatch_Enabled <Boolean>
-InvitationId <String>
-MemberConfiguration_KmsKeyArn <String>
-NetworkId <String>
-MemberConfiguration_Tag <Hashtable>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonManagedBlockchainConfig>

Description

Creates a member within a Managed Blockchain network. Applies only to Hyperledger Fabric.

Parameters

-ClientConfig <AmazonManagedBlockchainConfig>
Amazon.PowerShell.Cmdlets.MBC.AmazonManagedBlockchainClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientRequestToken <String>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than one time. 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 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
-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
-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)
-InvitationId <String>
The unique identifier of the invitation that is sent to the member to join the network.
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?1
Accept pipeline input?True (ByValue, 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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMemberConfiguration_Tags
-NetworkId <String>
The unique identifier of the network in which the member is created.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'MemberId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ManagedBlockchain.Model.CreateMemberResponse). Specifying the name of a property of type Amazon.ManagedBlockchain.Model.CreateMemberResponse 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)

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

System.String or Amazon.ManagedBlockchain.Model.CreateMemberResponse
This cmdlet returns a System.String object. The service call response (type Amazon.ManagedBlockchain.Model.CreateMemberResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

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