aws-cdk-lib.aws_iam.CfnServiceLinkedRoleProps

interface CfnServiceLinkedRoleProps

LanguageType name
.NETAmazon.CDK.AWS.IAM.CfnServiceLinkedRoleProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiam#CfnServiceLinkedRoleProps
Javasoftware.amazon.awscdk.services.iam.CfnServiceLinkedRoleProps
Pythonaws_cdk.aws_iam.CfnServiceLinkedRoleProps
TypeScript aws-cdk-lib » aws_iam » CfnServiceLinkedRoleProps

Properties for defining a CfnServiceLinkedRole.

Example

const slr = new iam.CfnServiceLinkedRole(this, 'ElasticSLR', {
  awsServiceName: 'es.amazonaws.com',
});

Properties

NameTypeDescription
awsServiceName?stringThe service principal for the AWS service to which this role is attached.
customSuffix?stringA string that you provide, which is combined with the service-provided prefix to form the complete role name.
description?stringThe description of the role.

awsServiceName?

Type: string (optional)

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.


customSuffix?

Type: string (optional)

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.


description?

Type: string (optional)

The description of the role.