Package com.pulumi.aws.ssm.inputs

Class DocumentState

  • public final class DocumentState
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  DocumentState.Builder  

      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<DocumentAttachmentsSourceArgs>>> attachmentsSources()  
      static DocumentState.Builder builder()  
      static DocumentState.Builder builder​(DocumentState defaults)  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> content()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> createdDate()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> defaultVersion()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> documentFormat()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> documentType()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> documentVersion()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> hash()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> hashType()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> latestVersion()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> owner()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<DocumentParameterArgs>>> parameters()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> permissions()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> platformTypes()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> schemaVersion()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> status()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tagsAll()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> targetType()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> versionName()  

      • Methods inherited from class com.pulumi.resources.ResourceArgs

        validateMember

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • arn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()
        Returns:
        ARN of the document.

      • attachmentsSources

        public java.util.Optional<com.pulumi.core.Output<java.util.List<DocumentAttachmentsSourceArgs>>> attachmentsSources()
        Returns:
        One or more configuration blocks describing attachments sources to a version of a document. See `attachmentsSource` block below for details.

      • content

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> content()
        Returns:
        The content for the SSM document in JSON or YAML format. The content of the document must not exceed 64KB. This quota also includes the content specified for input parameters at runtime. We recommend storing the contents for your new document in an external JSON or YAML file and referencing the file in a command.

      • createdDate

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> createdDate()
        Returns:
        The date the document was created.

      • defaultVersion

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> defaultVersion()
        Returns:
        The default version of the document.

      • description

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()
        Returns:
        A description of what the parameter does, how to use it, the default value, and whether or not the parameter is optional.

      • documentFormat

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> documentFormat()
        Returns:
        The format of the document. Valid values: `JSON`, `TEXT`, `YAML`.

      • documentType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> documentType()
        Returns:
        The type of the document. For a list of valid values, see the [API Reference](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_CreateDocument.html#systemsmanager-CreateDocument-request-DocumentType).

      • documentVersion

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> documentVersion()
        Returns:
        The document version.

      • hash

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> hash()
        Returns:
        The Sha256 or Sha1 hash created by the system when the document was created.

      • hashType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> hashType()
        Returns:
        The hash type of the document. Valid values: `Sha256`, `Sha1`.

      • latestVersion

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> latestVersion()
        Returns:
        The latest version of the document.

      • name

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        The name of the document.

      • owner

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> owner()
        Returns:
        The Amazon Web Services user that created the document.

      • parameters

        public java.util.Optional<com.pulumi.core.Output<java.util.List<DocumentParameterArgs>>> parameters()
        Returns:
        One or more configuration blocks describing the parameters for the document. See `parameter` block below for details.

      • permissions

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> permissions()
        Returns:
        Additional permissions to attach to the document. See Permissions below for details.

      • platformTypes

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> platformTypes()
        Returns:
        The list of operating system (OS) platforms compatible with this SSM document. Valid values: `Windows`, `Linux`, `MacOS`.

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • schemaVersion

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> schemaVersion()
        Returns:
        The schema version of the document.

      • status

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> status()
        Returns:
        The status of the SSM document. Valid values: `Creating`, `Active`, `Updating`, `Deleting`, `Failed`.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        A map of tags to assign to the object. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • targetType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> targetType()
        Returns:
        The target type which defines the kinds of resources the document can run on. For example, `/AWS::EC2::Instance`. For a list of valid resource types, see [AWS resource and property types reference](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html).

      • versionName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> versionName()
        Returns:
        The version of the artifact associated with the document. For example, `12.6`. This value is unique across all versions of a document, and can't be changed.