aws2-iam/component.json

{
  "component": {
    "kind": "component",
    "name": "aws2-iam",
    "title": "AWS Identity and Access Management (IAM)",
    "description": "Manage AWS IAM instances.",
    "deprecated": false,
    "firstVersion": "3.1.0",
    "label": "cloud,management",
    "javaType": "org.apache.camel.component.aws2.iam.IAM2Component",
    "supportLevel": "Stable",
    "groupId": "org.apache.camel",
    "artifactId": "camel-aws2-iam",
    "version": "4.10.2",
    "scheme": "aws2-iam",
    "extendsScheme": "",
    "syntax": "aws2-iam:label",
    "async": false,
    "api": false,
    "consumerOnly": false,
    "producerOnly": true,
    "lenientProperties": false,
    "browsable": false,
    "remote": true
  },
  "headers": {
    "CamelAwsIAMOperation": {
      "index": 0,
      "kind": "header",
      "displayName": "",
      "group": "producer",
      "label": "",
      "required": false,
      "javaType": "String",
      "deprecated": false,
      "deprecationNote": "",
      "autowired": false,
      "secret": false,
      "description": "The operation we want to perform",
      "constantName": "org.apache.camel.component.aws2.iam.IAM2Constants#OPERATION"
    },
    "CamelAwsIAMUsername": {
      "index": 1,
      "kind": "header",
      "displayName": "",
      "group": "producer",
      "label": "",
      "required": false,
      "javaType": "String",
      "deprecated": false,
      "deprecationNote": "",
      "autowired": false,
      "secret": false,
      "description": "The username for the user you want to manage",
      "constantName": "org.apache.camel.component.aws2.iam.IAM2Constants#USERNAME"
    },
    "CamelAwsIAMAccessKeyID": {
      "index": 2,
      "kind": "header",
      "displayName": "",
      "group": "producer",
      "label": "",
      "required": false,
      "javaType": "String",
      "deprecated": false,
      "deprecationNote": "",
      "autowired": false,
      "secret": false,
      "description": "The accessKey you want to manage",
      "constantName": "org.apache.camel.component.aws2.iam.IAM2Constants#ACCESS_KEY_ID"
    },
    "CamelAwsIAMAccessKeyStatus": {
      "index": 3,
      "kind": "header",
      "displayName": "",
      "group": "producer",
      "label": "",
      "required": false,
      "javaType": "String",
      "deprecated": false,
      "deprecationNote": "",
      "autowired": false,
      "secret": false,
      "description": "The Status of the AccessKey you want to set, possible value are active and inactive",
      "constantName": "org.apache.camel.component.aws2.iam.IAM2Constants#ACCESS_KEY_STATUS"
    },
    "CamelAwsIAMGroupName": {
      "index": 4,
      "kind": "header",
      "displayName": "",
      "group": "producer",
      "label": "",
      "required": false,
      "javaType": "String",
      "deprecated": false,
      "deprecationNote": "",
      "autowired": false,
      "secret": false,
      "description": "The name of an AWS IAM Group",
      "constantName": "org.apache.camel.component.aws2.iam.IAM2Constants#GROUP_NAME"
    },
    "CamelAwsIAMGroupPath": {
      "index": 5,
      "kind": "header",
      "displayName": "",
      "group": "producer",
      "label": "",
      "required": false,
      "javaType": "String",
      "deprecated": false,
      "deprecationNote": "",
      "autowired": false,
      "secret": false,
      "description": "The path of an AWS IAM Group",
      "constantName": "org.apache.camel.component.aws2.iam.IAM2Constants#GROUP_PATH"
    }
  },
  "properties": {
    "label": {
      "index": 0,
      "kind": "path",
      "displayName": "Label",
      "group": "producer",
      "label": "",
      "required": true,
      "type": "string",
      "javaType": "java.lang.String",
      "deprecated": false,
      "deprecationNote": "",
      "autowired": false,
      "secret": false,
      "configurationClass": "org.apache.camel.component.aws2.iam.IAM2Configuration",
      "configurationField": "configuration",
      "description": "Logical name"
    },
    "iamClient": {
      "index": 1,
      "kind": "parameter",
      "displayName": "Iam Client",
      "group": "producer",
      "label": "",
      "required": false,
      "type": "object",
      "javaType": "software.amazon.awssdk.services.iam.IamClient",
      "deprecated": false,
      "deprecationNote": "",
      "autowired": true,
      "secret": false,
      "configurationClass": "org.apache.camel.component.aws2.iam.IAM2Configuration",
      "configurationField": "configuration",
      "description": "To use an existing configured AWS IAM client"
    },
    "operation": {
      "index": 2,
      "kind": "parameter",
      "displayName": "Operation",
      "group": "producer",
      "label": "",
      "required": false,
      "type": "object",
      "javaType": "org.apache.camel.component.aws2.iam.IAM2Operations",
      "enum": [
        "listAccessKeys",
        "createUser",
        "deleteUser",
        "getUser",
        "listUsers",
        "createAccessKey",
        "deleteAccessKey",
        "updateAccessKey",
        "createGroup",
        "deleteGroup",
        "listGroups",
        "addUserToGroup",
        "removeUserFromGroup"
      ],
      "deprecated": false,
      "autowired": false,
      "secret": false,
      "configurationClass": "org.apache.camel.component.aws2.iam.IAM2Configuration",
      "configurationField": "configuration",
      "description": "The operation to perform. You can configure a default operation on the component level, or the operation as part of the endpoint, or via a message header with the key CamelAwsIAMOperation."
    },
    "overrideEndpoint": {
      "index": 3,
      "kind": "parameter",
      "displayName": "Override Endpoint",
      "group": "producer",
      "label": "",
      "required": false,
      "type": "boolean",
      "javaType": "boolean",
      "deprecated": false,
      "autowired": false,
      "secret": false,
      "defaultValue": false,
      "configurationClass": "org.apache.camel.component.aws2.iam.IAM2Configuration",
      "configurationField": "configuration",
      "description": "Set the need for overriding the endpoint. This option needs to be used in combination with the uriEndpointOverride option"
    },
    "pojoRequest": {
      "index": 4,
      "kind": "parameter",
      "displayName": "Pojo Request",
      "group": "producer",
      "label": "",
      "required": false,
      "type": "boolean",
      "javaType": "boolean",
      "deprecated": false,
      "autowired": false,
      "secret": false,
      "defaultValue": false,
      "configurationClass": "org.apache.camel.component.aws2.iam.IAM2Configuration",
      "configurationField": "configuration",
      "description": "If we want to use a POJO request as body or not"
    },
    "region": {
      "index": 5,
      "kind": "parameter",
      "displayName": "Region",
      "group": "producer",
      "label": "",
      "required": false,
      "type": "string",
      "javaType": "java.lang.String",
      "enum": [
        "ap-south-2",
        "ap-south-1",
        "eu-south-1",
        "eu-south-2",
        "us-gov-east-1",
        "me-central-1",
        "il-central-1",
        "ca-central-1",
        "eu-central-1",
        "us-iso-west-1",
        "eu-central-2",
        "us-west-1",
        "us-west-2",
        "af-south-1",
        "eu-north-1",
        "eu-west-3",
        "eu-west-2",
        "eu-west-1",
        "ap-northeast-3",
        "ap-northeast-2",
        "ap-northeast-1",
        "me-south-1",
        "sa-east-1",
        "ap-east-1",
        "cn-north-1",
        "us-gov-west-1",
        "ap-southeast-1",
        "ap-southeast-2",
        "us-iso-east-1",
        "ap-southeast-3",
        "ap-southeast-4",
        "us-east-1",
        "us-east-2",
        "cn-northwest-1",
        "us-isob-east-1",
        "aws-global",
        "aws-cn-global",
        "aws-us-gov-global",
        "aws-iso-global",
        "aws-iso-b-global"
      ],
      "deprecated": false,
      "autowired": false,
      "secret": false,
      "defaultValue": "aws-global",
      "configurationClass": "org.apache.camel.component.aws2.iam.IAM2Configuration",
      "configurationField": "configuration",
      "description": "The region in which IAM client needs to work. When using this parameter, the configuration will expect the lowercase name of the region (for example, ap-east-1) You'll need to use the name Region.EU_WEST_1.id()"
    },
    "uriEndpointOverride": {
      "index": 6,
      "kind": "parameter",
      "displayName": "Uri Endpoint Override",
      "group": "producer",
      "label": "",
      "required": false,
      "type": "string",
      "javaType": "java.lang.String",
      "deprecated": false,
      "autowired": false,
      "secret": false,
      "configurationClass": "org.apache.camel.component.aws2.iam.IAM2Configuration",
      "configurationField": "configuration",
      "description": "Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option"
    },
    "lazyStartProducer": {
      "index": 7,
      "kind": "parameter",
      "displayName": "Lazy Start Producer",
      "group": "producer (advanced)",
      "label": "producer,advanced",
      "required": false,
      "type": "boolean",
      "javaType": "boolean",
      "deprecated": false,
      "autowired": false,
      "secret": false,
      "defaultValue": false,
      "description": "Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing."
    },
    "proxyHost": {
      "index": 8,
      "kind": "parameter",
      "displayName": "Proxy Host",
      "group": "proxy",
      "label": "proxy",
      "required": false,
      "type": "string",
      "javaType": "java.lang.String",
      "deprecated": false,
      "autowired": false,
      "secret": false,
      "configurationClass": "org.apache.camel.component.aws2.iam.IAM2Configuration",
      "configurationField": "configuration",
      "description": "To define a proxy host when instantiating the IAM client"
    },
    "proxyPort": {
      "index": 9,
      "kind": "parameter",
      "displayName": "Proxy Port",
      "group": "proxy",
      "label": "proxy",
      "required": false,
      "type": "integer",
      "javaType": "java.lang.Integer",
      "deprecated": false,
      "autowired": false,
      "secret": false,
      "configurationClass": "org.apache.camel.component.aws2.iam.IAM2Configuration",
      "configurationField": "configuration",
      "description": "To define a proxy port when instantiating the IAM client"
    },
    "proxyProtocol": {
      "index": 10,
      "kind": "parameter",
      "displayName": "Proxy Protocol",
      "group": "proxy",
      "label": "proxy",
      "required": false,
      "type": "object",
      "javaType": "software.amazon.awssdk.core.Protocol",
      "enum": [
        "HTTP",
        "HTTPS"
      ],
      "deprecated": false,
      "autowired": false,
      "secret": false,
      "defaultValue": "HTTPS",
      "configurationClass": "org.apache.camel.component.aws2.iam.IAM2Configuration",
      "configurationField": "configuration",
      "description": "To define a proxy protocol when instantiating the IAM client"
    },
    "accessKey": {
      "index": 11,
      "kind": "parameter",
      "displayName": "Access Key",
      "group": "security",
      "label": "security",
      "required": false,
      "type": "string",
      "javaType": "java.lang.String",
      "deprecated": false,
      "autowired": false,
      "secret": true,
      "configurationClass": "org.apache.camel.component.aws2.iam.IAM2Configuration",
      "configurationField": "configuration",
      "description": "Amazon AWS Access Key"
    },
    "profileCredentialsName": {
      "index": 12,
      "kind": "parameter",
      "displayName": "Profile Credentials Name",
      "group": "security",
      "label": "security",
      "required": false,
      "type": "string",
      "javaType": "java.lang.String",
      "deprecated": false,
      "autowired": false,
      "secret": false,
      "configurationClass": "org.apache.camel.component.aws2.iam.IAM2Configuration",
      "configurationField": "configuration",
      "description": "If using a profile credentials provider, this parameter will set the profile name"
    },
    "secretKey": {
      "index": 13,
      "kind": "parameter",
      "displayName": "Secret Key",
      "group": "security",
      "label": "security",
      "required": false,
      "type": "string",
      "javaType": "java.lang.String",
      "deprecated": false,
      "autowired": false,
      "secret": true,
      "configurationClass": "org.apache.camel.component.aws2.iam.IAM2Configuration",
      "configurationField": "configuration",
      "description": "Amazon AWS Secret Key"
    },
    "sessionToken": {
      "index": 14,
      "kind": "parameter",
      "displayName": "Session Token",
      "group": "security",
      "label": "security",
      "required": false,
      "type": "string",
      "javaType": "java.lang.String",
      "deprecated": false,
      "autowired": false,
      "secret": true,
      "configurationClass": "org.apache.camel.component.aws2.iam.IAM2Configuration",
      "configurationField": "configuration",
      "description": "Amazon AWS Session Token used when the user needs to assume an IAM role"
    },
    "trustAllCertificates": {
      "index": 15,
      "kind": "parameter",
      "displayName": "Trust All Certificates",
      "group": "security",
      "label": "security",
      "required": false,
      "type": "boolean",
      "javaType": "boolean",
      "deprecated": false,
      "autowired": false,
      "secret": false,
      "defaultValue": false,
      "configurationClass": "org.apache.camel.component.aws2.iam.IAM2Configuration",
      "configurationField": "configuration",
      "description": "If we want to trust all certificates in case of overriding the endpoint"
    },
    "useDefaultCredentialsProvider": {
      "index": 16,
      "kind": "parameter",
      "displayName": "Use Default Credentials Provider",
      "group": "security",
      "label": "security",
      "required": false,
      "type": "boolean",
      "javaType": "boolean",
      "deprecated": false,
      "autowired": false,
      "secret": false,
      "defaultValue": false,
      "configurationClass": "org.apache.camel.component.aws2.iam.IAM2Configuration",
      "configurationField": "configuration",
      "description": "Set whether the IAM client should expect to load credentials through a default credentials provider or to expect static credentials to be passed in."
    },
    "useProfileCredentialsProvider": {
      "index": 17,
      "kind": "parameter",
      "displayName": "Use Profile Credentials Provider",
      "group": "security",
      "label": "security",
      "required": false,
      "type": "boolean",
      "javaType": "boolean",
      "deprecated": false,
      "autowired": false,
      "secret": false,
      "defaultValue": false,
      "configurationClass": "org.apache.camel.component.aws2.iam.IAM2Configuration",
      "configurationField": "configuration",
      "description": "Set whether the IAM client should expect to load credentials through a profile credentials provider."
    },
    "useSessionCredentials": {
      "index": 18,
      "kind": "parameter",
      "displayName": "Use Session Credentials",
      "group": "security",
      "label": "security",
      "required": false,
      "type": "boolean",
      "javaType": "boolean",
      "deprecated": false,
      "autowired": false,
      "secret": false,
      "defaultValue": false,
      "configurationClass": "org.apache.camel.component.aws2.iam.IAM2Configuration",
      "configurationField": "configuration",
      "description": "Set whether the IAM client should expect to use Session Credentials. This is useful in a situation in which the user needs to assume a IAM role for doing operations in IAM."
    }
  }
}