Class: Aws::IAM::Types::CreateServiceLinkedRoleRequest

Inherits:

Struct

• Object
• Struct
• Aws::IAM::Types::CreateServiceLinkedRoleRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iam/types.rb

Overview

Note:

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

{
  aws_service_name: "groupNameType", # required
  description: "roleDescriptionType",
  custom_suffix: "customSuffixType",
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #aws_service_name ⇒ String

  The service principal for the AWS service to which this role is attached.

• #custom_suffix ⇒ String

  A string that you provide, which is combined with the service-provided prefix to form the complete role name.

• #description ⇒ String

  The description of the role.

Instance Attribute Details

#aws_service_name ⇒ String

The service principal for the AWS service to which this role is attached. You use a string similar to a URL but without the http:// in front. For example: ‘elasticbeanstalk.amazonaws.com`.

Service principals are unique and case-sensitive. To find the exact service principal for your service-linked role, see [AWS Services That Work with IAM] in the *IAM User Guide* and look for the services that have Yes in the **Service-Linked Role** column. Choose the Yes link to view the service-linked role documentation for that service.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-services-that-work-with-iam.html

Returns:

• (String)

# File 'lib/aws-sdk-iam/types.rb', line 1325

class CreateServiceLinkedRoleRequest < Struct.new(
  :aws_service_name,
  :description,
  :custom_suffix)
  include Aws::Structure
end

#custom_suffix ⇒ String

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 ‘CustomSuffix` for each request. Otherwise the request fails with a duplicate role name error. For example, you could add `-1` or `-debug` to the suffix.

Some services do not support the ‘CustomSuffix` parameter. If you provide an optional suffix and the operation fails, try the operation again without the suffix.

Returns:

• (String)

# File 'lib/aws-sdk-iam/types.rb', line 1325

class CreateServiceLinkedRoleRequest < Struct.new(
  :aws_service_name,
  :description,
  :custom_suffix)
  include Aws::Structure
end

#description ⇒ String

The description of the role.

Returns:

• (String)

# File 'lib/aws-sdk-iam/types.rb', line 1325

class CreateServiceLinkedRoleRequest < Struct.new(
  :aws_service_name,
  :description,
  :custom_suffix)
  include Aws::Structure
end