DocumentParameter (com.pulumi.aws API)

java.lang.Object
- com.pulumi.aws.ssm.outputs.DocumentParameter

public final class DocumentParameter
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class DocumentParameter.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DocumentParameter.Builder`	`builder()`
`static DocumentParameter.Builder`	`builder(DocumentParameter defaults)`
`java.util.Optional<java.lang.String>`	`defaultValue()`
`java.util.Optional<java.lang.String>`	`description()`
`java.util.Optional<java.lang.String>`	`name()`
`java.util.Optional<java.lang.String>`	`type()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - defaultValue
```
public java.util.Optional<java.lang.String> defaultValue()
```
    Returns:
    
    If specified, the default values for the parameters. Parameters without a default value are required. Parameters with a default value are optional.
  - description
```
public java.util.Optional<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.
  - name
```
public java.util.Optional<java.lang.String> name()
```
    Returns:
    
    The name of the document.
  - type
```
public java.util.Optional<java.lang.String> type()
```
    Returns:
    
    The type of parameter. Valid values: `String`, `StringList`.
  - builder
```
public static DocumentParameter.Builder builder()
```
  - builder
```
public static DocumentParameter.Builder builder(DocumentParameter defaults)
```