Class CfnServiceLinkedRole

Namespace

Amazon.CDK.AWS.IAM

Assembly

Amazon.CDK.AWS.IAM.dll

A CloudFormation AWS::IAM::ServiceLinkedRole.

public class CfnServiceLinkedRole : CfnResource, IInspectable

Inheritance

object

CfnServiceLinkedRole

Implements

IInspectable

Examples

var slr = new CfnServiceLinkedRole(this, "ElasticSLR", new CfnServiceLinkedRoleProps {
                 AwsServiceName = "es.amazonaws.com"
             });

Remarks

Creates an IAM role that is linked to a specific AWS service. The service controls the attached policies and when the role can be deleted. This helps ensure that the service is not broken by an unexpectedly changed or deleted role, which could put your AWS resources into an unknown state. Allowing the service to control the role helps improve service stability and proper cleanup when a service and its role are no longer needed. For more information, see Using service-linked roles in the IAM User Guide .

To attach a policy to this service-linked role, you must make the request using the AWS service that depends on this role.

CloudformationResource: AWS::IAM::ServiceLinkedRole

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servicelinkedrole.html

ExampleMetadata: infused

Constructors

CfnServiceLinkedRole(Construct, string, ICfnServiceLinkedRoleProps)

Create a new AWS::IAM::ServiceLinkedRole.

public CfnServiceLinkedRole(Construct scope, string id, ICfnServiceLinkedRoleProps props)

Parameters

scope Construct

• scope in which this resource is defined.

id string

• scoped id of the resource.

props ICfnServiceLinkedRoleProps

• resource properties.

Properties

AwsServiceName

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

public virtual string AwsServiceName { get; set; }

Property Value

string

Remarks

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servicelinkedrole.html#cfn-iam-servicelinkedrole-awsservicename

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

CustomSuffix

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

public virtual string? CustomSuffix { get; set; }

Property Value

string

Remarks

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servicelinkedrole.html#cfn-iam-servicelinkedrole-customsuffix

Description

The description of the role.

public virtual string? Description { get; set; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-servicelinkedrole.html#cfn-iam-servicelinkedrole-description

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

• tree inspector to collect and process attributes.

RenderProperties(IDictionary<string, object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>