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::CreateProposalInput

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 CreateProposalInput data as a hash:

{
  client_request_token: "ClientRequestTokenString", # required
  network_id: "ResourceIdString", # required
  member_id: "ResourceIdString", # required
  actions: { # required
    invitations: [
      {
        principal: "PrincipalString", # required
      },
    ],
    removals: [
      {
        member_id: "ResourceIdString", # required
      },
    ],
  },
  description: "DescriptionString",
  tags: {
    "TagKey" => "TagValue",
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#actionsTypes::ProposalActions

The type of actions proposed, such as inviting a member or removing a member. The types of Actions in a proposal are mutually exclusive. For example, a proposal with Invitations actions cannot also contain Removals actions.



486
487
488
489
490
491
492
493
494
495
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/types.rb', line 486

class CreateProposalInput < Struct.new(
  :client_request_token,
  :network_id,
  :member_id,
  :actions,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#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)


486
487
488
489
490
491
492
493
494
495
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/types.rb', line 486

class CreateProposalInput < Struct.new(
  :client_request_token,
  :network_id,
  :member_id,
  :actions,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description for the proposal that is visible to voting members, for example, "Proposal to add Example Corp. as member."

Returns:

  • (String)


486
487
488
489
490
491
492
493
494
495
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/types.rb', line 486

class CreateProposalInput < Struct.new(
  :client_request_token,
  :network_id,
  :member_id,
  :actions,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#member_idString

The unique identifier of the member that is creating the proposal. This identifier is especially useful for identifying the member making the proposal when multiple members exist in a single AWS account.

Returns:

  • (String)


486
487
488
489
490
491
492
493
494
495
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/types.rb', line 486

class CreateProposalInput < Struct.new(
  :client_request_token,
  :network_id,
  :member_id,
  :actions,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#network_idString

The unique identifier of the network for which the proposal is made.

Returns:

  • (String)


486
487
488
489
490
491
492
493
494
495
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/types.rb', line 486

class CreateProposalInput < Struct.new(
  :client_request_token,
  :network_id,
  :member_id,
  :actions,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

Tags to assign to the proposal. 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. If the proposal is for a network invitation, the invitation inherits the tags added to the proposal.

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>)


486
487
488
489
490
491
492
493
494
495
# File 'gems/aws-sdk-managedblockchain/lib/aws-sdk-managedblockchain/types.rb', line 486

class CreateProposalInput < Struct.new(
  :client_request_token,
  :network_id,
  :member_id,
  :actions,
  :description,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end