Package software.amazon.awscdk.services.iam

Class CfnServiceLinkedRole

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.iam.CfnServiceLinkedRole
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.275Z") @Stability(Stable) public class CfnServiceLinkedRole extends CfnResource implements IInspectable
A CloudFormation AWS::IAM::ServiceLinkedRole.

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.

Example: 

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

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnServiceLinkedRole

      protected CfnServiceLinkedRole(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnServiceLinkedRole

      protected CfnServiceLinkedRole(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnServiceLinkedRole

      @Stability(Stable) public CfnServiceLinkedRole(@NotNull Construct scope, @NotNull String id, @NotNull CfnServiceLinkedRoleProps props)
      Create a new AWS::IAM::ServiceLinkedRole.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getAwsServiceName

      @Stability(Stable) @NotNull public 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.

    • setAwsServiceName

      @Stability(Stable) public void setAwsServiceName(@NotNull String value)
      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.

    • getCustomSuffix

      @Stability(Stable) @Nullable public 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.

    • setCustomSuffix

      @Stability(Stable) public void setCustomSuffix(@Nullable String value)
      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.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the role.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the role.