Package software.amazon.awscdk.services.iam

Interface CfnServiceLinkedRoleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnServiceLinkedRoleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-06T14:43:20.080Z")
@Stability(Stable)
public interface CfnServiceLinkedRoleProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnServiceLinkedRole.

Example:

 CfnServiceLinkedRole slr = CfnServiceLinkedRole.Builder.create(this, "ElasticSLR")
         .awsServiceName("es.amazonaws.com")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnServiceLinkedRoleProps.Builder	A builder for CfnServiceLinkedRoleProps
static final class	CfnServiceLinkedRoleProps.Jsii$Proxy	An implementation for CfnServiceLinkedRoleProps

Method Summary

Modifier and Type	Method	Description
static CfnServiceLinkedRoleProps.Builder	builder()
default String	getAwsServiceName()	The service principal for the AWS service to which this role is attached.
default String	getCustomSuffix()	A string that you provide, which is combined with the service-provided prefix to form the complete role name.
default String	getDescription()	The description of the role.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAwsServiceName

@Stability(Stable)
@Nullable
default String getAwsServiceName()

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.

See Also:

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

getCustomSuffix

@Stability(Stable)
@Nullable
default String getCustomSuffix()

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.

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the role.

See Also:

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

builder

@Stability(Stable)
static CfnServiceLinkedRoleProps.Builder builder()

Returns:

a CfnServiceLinkedRoleProps.Builder of CfnServiceLinkedRoleProps