Class CfnServiceLinkedRole

Creates an IAM role that is linked to a specific AWS service.

Inheritance

System.Object

CfnElement

CfnRefElement

CfnResource

CfnServiceLinkedRole

Implements

IInspectable

Inherited Members

CfnResource.IsCfnResource(Object)

CfnResource.AddDeletionOverride(String)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(String, Object)

CfnResource.AddOverride(String, Object)

CfnResource.AddPropertyDeletionOverride(String)

CfnResource.AddPropertyOverride(String, Object)

CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String, Nullable<ResolutionTypeHint>)

CfnResource.GetMetadata(String)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(Object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.IAM

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnServiceLinkedRole : CfnResource, IInspectable

Syntax (vb)

Public Class CfnServiceLinkedRole
    Inherits CfnResource
    Implements IInspectable

Remarks

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.

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

CloudformationResource: AWS::IAM::ServiceLinkedRole

ExampleMetadata: infused

Examples

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

Synopsis

Constructors

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
CfnServiceLinkedRole(Construct, String, ICfnServiceLinkedRoleProps)

Properties

AttrRoleName	Returns the friendly name that identifies the role.
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(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

CfnServiceLinkedRole(Construct, String, ICfnServiceLinkedRoleProps)

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

Parameters

scope Constructs.Construct: Scope in which this resource is defined.
id System.String: Construct identifier for this resource (unique in its scope).
props ICfnServiceLinkedRoleProps: Resource properties.

Properties

AttrRoleName

Returns the friendly name that identifies the role.

public virtual string AttrRoleName { get; }

Property Value

System.String

Remarks

For example, AWSServiceRoleForAutoScaling or AWSServiceRoleForAutoScaling_TestSuffix if a CustomSuffix is specified.

CloudformationAttribute: RoleName

AwsServiceName

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

public virtual string AwsServiceName { get; set; }

Property Value

System.String

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

CfnResource.CfnProperties

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

Description

The description of the role.

public virtual string Description { get; set; }

Property Value

System.String

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>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IInspectable