You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iam/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",
}

Instance Attribute Summary collapse

Instance Attribute Details

#aws_service_nameString

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

Returns:

  • (String)


1430
1431
1432
1433
1434
1435
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 1430

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

#custom_suffixString

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)


1430
1431
1432
1433
1434
1435
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 1430

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

#descriptionString

The description of the role.

Returns:

  • (String)


1430
1431
1432
1433
1434
1435
# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 1430

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