Package software.amazon.awscdk.services.ssm

Class CfnOpsItem

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.CfnOpsItem
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IOpsItemRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)", date="2026-08-10T14:51:12.469Z") @Stability(Stable) public class CfnOpsItem extends CfnResource implements IInspectable, IOpsItemRef, ITaggableV2
Resource schema for AWS::SSM::OpsItem.

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.*;
 CfnOpsItem cfnOpsItem = CfnOpsItem.Builder.create(this, "MyCfnOpsItem")
         .description("description")
         .source("source")
         .title("title")
         // the properties below are optional
         .category("category")
         .priority(123)
         .severity("severity")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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

    • CfnOpsItem

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

    • CfnOpsItem

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

    • CfnOpsItem

      @Stability(Stable) public CfnOpsItem(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnOpsItemProps props)
      Create a new AWS::SSM::OpsItem.

      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

    • arnForOpsItem

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

    • isCfnOpsItem

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

      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.

    • getAttrCreatedBy

      @Stability(Stable) @NotNull public String getAttrCreatedBy()
      The user who created the OpsItem.

    • getAttrCreatedTime

      @Stability(Stable) @NotNull public String getAttrCreatedTime()
      The time the OpsItem was created.

    • getAttrLastModifiedBy

      @Stability(Stable) @NotNull public String getAttrLastModifiedBy()
      The user who last modified the OpsItem.

    • getAttrLastModifiedTime

      @Stability(Stable) @NotNull public String getAttrLastModifiedTime()
      The time the OpsItem was last modified.

    • getAttrOpsItemArn

      @Stability(Stable) @NotNull public String getAttrOpsItemArn()
      The ARN of the OpsItem.

    • getAttrOpsItemId

      @Stability(Stable) @NotNull public String getAttrOpsItemId()
      The ID of the OpsItem.

    • getAttrOpsItemType

      @Stability(Stable) @NotNull public String getAttrOpsItemType()
      The type of OpsItem.

    • getAttrStatus

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

    • getAttrVersion

      @Stability(Stable) @NotNull public String getAttrVersion()
      The version of the OpsItem.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • 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

    • getOpsItemRef

      @Stability(Stable) @NotNull public OpsItemReference getOpsItemRef()
      A reference to a OpsItem resource.
      Specified by:
      getOpsItemRef in interface IOpsItemRef

    • getDescription

      @Stability(Stable) @NotNull public String getDescription()
      The description of the OpsItem.

    • setDescription

      @Stability(Stable) public void setDescription(@NotNull String value)
      The description of the OpsItem.

    • getSource

      @Stability(Stable) @NotNull public String getSource()
      The origin of the OpsItem.

    • setSource

      @Stability(Stable) public void setSource(@NotNull String value)
      The origin of the OpsItem.

    • getTitle

      @Stability(Stable) @NotNull public String getTitle()
      The title of the OpsItem.

    • setTitle

      @Stability(Stable) public void setTitle(@NotNull String value)
      The title of the OpsItem.

    • getCategory

      @Stability(Stable) @Nullable public String getCategory()
      The category of the OpsItem.

    • setCategory

      @Stability(Stable) public void setCategory(@Nullable String value)
      The category of the OpsItem.

    • getPriority

      @Stability(Stable) @Nullable public Number getPriority()
      The priority of the OpsItem.

    • setPriority

      @Stability(Stable) public void setPriority(@Nullable Number value)
      The priority of the OpsItem.

    • getSeverity

      @Stability(Stable) @Nullable public String getSeverity()
      The severity of the OpsItem.

    • setSeverity

      @Stability(Stable) public void setSeverity(@Nullable String value)
      The severity of the OpsItem.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Tags for the OpsItem.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Tags for the OpsItem.