Class CfnServiceLinkedRole
A CloudFormation AWS::IAM::ServiceLinkedRole
.
Inherited Members
Namespace: Amazon.CDK.AWS.IAM
Assembly: Amazon.CDK.AWS.IAM.dll
Syntax (csharp)
public class CfnServiceLinkedRole : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnServiceLinkedRole
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
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
ExampleMetadata: infused
Examples
var slr = new CfnServiceLinkedRole(this, "ElasticSLR", new CfnServiceLinkedRoleProps {
AwsServiceName = "es.amazonaws.com"
});
Synopsis
Constructors
CfnServiceLinkedRole(Construct, String, ICfnServiceLinkedRoleProps) | Create a new |
CfnServiceLinkedRole(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnServiceLinkedRole(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AwsServiceName | The service principal for the AWS service to which this role is attached. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
CustomSuffix | A string that you provide, which is combined with the service-provided prefix to form the complete role name. |
Description | The description of the role. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
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 System.String
- scoped id of the resource.
- props ICfnServiceLinkedRoleProps
- resource properties.
CfnServiceLinkedRole(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnServiceLinkedRole(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnServiceLinkedRole(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnServiceLinkedRole(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AwsServiceName
The service principal for the AWS service to which this role is attached.
public virtual string AwsServiceName { get; set; }
Property Value
System.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.
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
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
System.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.
Description
The description of the role.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
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 System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>