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.

Class: Aws::ManagedBlockchain::Types::CreateNetworkInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/types.rb

Overview

Note:

When making an API call, you may pass CreateNetworkInput data as a hash:

{
  client_request_token: "ClientRequestTokenString", # required
  name: "NameString", # required
  description: "DescriptionString",
  framework: "HYPERLEDGER_FABRIC", # required, accepts HYPERLEDGER_FABRIC, ETHEREUM
  framework_version: "FrameworkVersionString", # required
  framework_configuration: {
    fabric: {
      edition: "STARTER", # required, accepts STARTER, STANDARD
    },
  },
  voting_policy: { # required
    approval_threshold_policy: {
      threshold_percentage: 1,
      proposal_duration_in_hours: 1,
      threshold_comparator: "GREATER_THAN", # accepts GREATER_THAN, GREATER_THAN_OR_EQUAL_TO
    },
  },
  member_configuration: { # required
    name: "NetworkMemberNameString", # required
    description: "DescriptionString",
    framework_configuration: { # required
      fabric: {
        admin_username: "UsernameString", # required
        admin_password: "PasswordString", # required
      },
    },
    log_publishing_configuration: {
      fabric: {
        ca_logs: {
          cloudwatch: {
            enabled: false,
          },
        },
      },
    },
    tags: {
      "TagKey" => "TagValue",
    },
    kms_key_arn: "ArnString",
  },
  tags: {
    "TagKey" => "TagValue",
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

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 AWS SDK or the AWS CLI.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


267
268
269
270
271
272
273
274
275
276
277
278
279
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/types.rb', line 267

class CreateNetworkInput < Struct.new(
  :client_request_token,
  :name,
  :description,
  :framework,
  :framework_version,
  :framework_configuration,
  :voting_policy,
  :member_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

An optional description for the network.

Returns:

  • (String)


267
268
269
270
271
272
273
274
275
276
277
278
279
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/types.rb', line 267

class CreateNetworkInput < Struct.new(
  :client_request_token,
  :name,
  :description,
  :framework,
  :framework_version,
  :framework_configuration,
  :voting_policy,
  :member_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#frameworkString

The blockchain framework that the network uses.

Returns:

  • (String)


267
268
269
270
271
272
273
274
275
276
277
278
279
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/types.rb', line 267

class CreateNetworkInput < Struct.new(
  :client_request_token,
  :name,
  :description,
  :framework,
  :framework_version,
  :framework_configuration,
  :voting_policy,
  :member_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#framework_configurationTypes::NetworkFrameworkConfiguration

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



267
268
269
270
271
272
273
274
275
276
277
278
279
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/types.rb', line 267

class CreateNetworkInput < Struct.new(
  :client_request_token,
  :name,
  :description,
  :framework,
  :framework_version,
  :framework_configuration,
  :voting_policy,
  :member_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#framework_versionString

The version of the blockchain framework that the network uses.

Returns:

  • (String)


267
268
269
270
271
272
273
274
275
276
277
278
279
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/types.rb', line 267

class CreateNetworkInput < Struct.new(
  :client_request_token,
  :name,
  :description,
  :framework,
  :framework_version,
  :framework_configuration,
  :voting_policy,
  :member_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#member_configurationTypes::MemberConfiguration

Configuration properties for the first member within the network.



267
268
269
270
271
272
273
274
275
276
277
278
279
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/types.rb', line 267

class CreateNetworkInput < Struct.new(
  :client_request_token,
  :name,
  :description,
  :framework,
  :framework_version,
  :framework_configuration,
  :voting_policy,
  :member_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the network.

Returns:

  • (String)


267
268
269
270
271
272
273
274
275
276
277
278
279
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/types.rb', line 267

class CreateNetworkInput < Struct.new(
  :client_request_token,
  :name,
  :description,
  :framework,
  :framework_version,
  :framework_configuration,
  :voting_policy,
  :member_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

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.

Returns:

  • (Hash<String,String>)


267
268
269
270
271
272
273
274
275
276
277
278
279
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/types.rb', line 267

class CreateNetworkInput < Struct.new(
  :client_request_token,
  :name,
  :description,
  :framework,
  :framework_version,
  :framework_configuration,
  :voting_policy,
  :member_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#voting_policyTypes::VotingPolicy

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

Returns:



267
268
269
270
271
272
273
274
275
276
277
278
279
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/types.rb', line 267

class CreateNetworkInput < Struct.new(
  :client_request_token,
  :name,
  :description,
  :framework,
  :framework_version,
  :framework_configuration,
  :voting_policy,
  :member_configuration,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end