Package software.amazon.awscdk.services.iam

Class CfnServiceLinkedRole.Builder

java.lang.Object

software.amazon.awscdk.services.iam.CfnServiceLinkedRole.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnServiceLinkedRole>

Enclosing class:

CfnServiceLinkedRole

@Stability(Stable)
public static final class CfnServiceLinkedRole.Builder
extends Object
implements software.amazon.jsii.Builder<CfnServiceLinkedRole>

A fluent builder for CfnServiceLinkedRole.

Method Summary

Modifier and Type	Method	Description
CfnServiceLinkedRole.Builder	awsServiceName(String awsServiceName)	The service principal for the AWS service to which this role is attached.
CfnServiceLinkedRole	build()
static CfnServiceLinkedRole.Builder	create(software.constructs.Construct scope, String id)
CfnServiceLinkedRole.Builder	customSuffix(String customSuffix)	A string that you provide, which is combined with the service-provided prefix to form the complete role name.
CfnServiceLinkedRole.Builder	description(String description)	The description of the role.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnServiceLinkedRole.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnServiceLinkedRole.Builder.

awsServiceName

@Stability(Stable)
public CfnServiceLinkedRole.Builder awsServiceName(String awsServiceName)

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.

Parameters:

awsServiceName - The service principal for the AWS service to which this role is attached. This parameter is required.

Returns:

this

See Also:

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

customSuffix

@Stability(Stable)
public CfnServiceLinkedRole.Builder customSuffix(String customSuffix)

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.

Parameters:

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

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnServiceLinkedRole.Builder description(String description)

The description of the role.

Parameters:

description - The description of the role. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnServiceLinkedRole build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnServiceLinkedRole>

Returns:

a newly built instance of CfnServiceLinkedRole.