Package software.amazon.awscdk.services.ssm

Class CfnServiceSetting

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.ssm.CfnServiceSetting
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IServiceSettingRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:19.778Z") @Stability(Stable) public class CfnServiceSetting extends CfnResource implements IInspectable, IServiceSettingRef
Resource Type definition for AWS::SSM::ServiceSetting.

ServiceSetting is an account-level setting for an AWS service that defines how a user interacts with or uses a service or feature.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ssm.*;
 CfnServiceSetting cfnServiceSetting = CfnServiceSetting.Builder.create(this, "MyCfnServiceSetting")
         .settingId("settingId")
         .settingValue("settingValue")
         .build();

See Also:

  • 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

    • CfnServiceSetting

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

    • CfnServiceSetting

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

    • CfnServiceSetting

      @Stability(Stable) public CfnServiceSetting(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnServiceSettingProps props)
      Create a new AWS::SSM::ServiceSetting.

      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.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForServiceSetting

      @Stability(Stable) @NotNull public static String arnForServiceSetting(@NotNull IServiceSettingRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnServiceSetting

      @Stability(Stable) @NotNull public static Boolean isCfnServiceSetting(@NotNull Object x)
      Checks whether the given object is a CfnServiceSetting.

      Parameters:
      x - This parameter is required.

    • 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.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The ARN of the service setting.

    • getAttrLastModifiedDate

      @Stability(Stable) @NotNull public String getAttrLastModifiedDate()
      The last time the service setting was modified.

    • getAttrLastModifiedUser

      @Stability(Stable) @NotNull public String getAttrLastModifiedUser()
      The ARN of the last modified user.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of the service setting.

      The value can be Default, Customized or PendingUpdate.

    • getCfnProperties

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

    • getCfnPropertyNames

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

    • getServiceSettingRef

      @Stability(Stable) @NotNull public ServiceSettingReference getServiceSettingRef()
      A reference to a ServiceSetting resource.
      Specified by:
      getServiceSettingRef in interface IServiceSettingRef

    • getSettingId

      @Stability(Stable) @NotNull public String getSettingId()
      The ID of the service setting, such as /ssm/parameter-store/high-throughput-enabled.

    • setSettingId

      @Stability(Stable) public void setSettingId(@NotNull String value)
      The ID of the service setting, such as /ssm/parameter-store/high-throughput-enabled.

    • getSettingValue

      @Stability(Stable) @NotNull public String getSettingValue()
      The value of the service setting.

    • setSettingValue

      @Stability(Stable) public void setSettingValue(@NotNull String value)
      The value of the service setting.