Show / Hide Table of Contents

Interface ICfnServiceLinkedRoleProps

Properties for defining a CfnServiceLinkedRole.

Namespace: Amazon.CDK.AWS.IAM
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnServiceLinkedRoleProps
Syntax (vb)
Public Interface ICfnServiceLinkedRoleProps
Remarks

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

ExampleMetadata: infused

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

Synopsis

Properties

AwsServiceName

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

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.

Properties

AwsServiceName

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

string? AwsServiceName { get; }
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.

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

CustomSuffix

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

string? CustomSuffix { get; }
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.

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

Description

The description of the role.

string? Description { get; }
Property Value

string

Remarks

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

Back to top Generated by DocFX