CreateServiceLinkedRoleRequest

APIs.ioEngineeringPlatform

Properties

Name Type Description
AWSServiceName object
Description object
CustomSuffix object
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-createservicelinkedrolerequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateServiceLinkedRoleRequest",
  "title": "CreateServiceLinkedRoleRequest",
  "type": "object",
  "required": [
    "AWSServiceName"
  ],
  "properties": {
    "AWSServiceName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/groupNameType"
        },
        {
          "description": "<p>The service principal for the Amazon Web Services service to which this role is attached. You use a string similar to a URL but without the http:// in front. For example: <code>elasticbeanstalk.amazonaws.com</code>. </p> <p>Service principals are unique and case-sensitive. To find the exact service principal for your service-linked role, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html\">Amazon Web Services services that work with IAM</a> in the <i>IAM User Guide</i>. Look for the services that have <b>Yes </b>in the <b>Service-Linked Role</b> column. Choose the <b>Yes</b> link to view the service-linked role documentation for that service.</p>"
        }
      ]
    },
    "Description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/roleDescriptionType"
        },
        {
          "description": "The description of the role."
        }
      ]
    },
    "CustomSuffix": {
      "allOf": [
        {
          "$ref": "#/components/schemas/customSuffixType"
        },
        {
          "description": "<p/> <p>A string that you provide, which is combined with the service-provided prefix to form the complete role name. If you make multiple requests for the same service, then you must supply a different <code>CustomSuffix</code> for each request. Otherwise the request fails with a duplicate role name error. For example, you could add <code>-1</code> or <code>-debug</code> to the suffix.</p> <p>Some services do not support the <code>CustomSuffix</code> parameter. If you provide an optional suffix and the operation fails, try the operation again without the suffix.</p>"
        }
      ]
    }
  }
}