Class WorkspaceApiKeyState


  • public final class WorkspaceApiKeyState
    extends com.pulumi.resources.ResourceArgs
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  WorkspaceApiKeyState.Builder  
      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal
    • Method Detail

      • key

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> key()
        Returns:
        Key token in JSON format. Use this value as a bearer token to authenticate HTTP requests to the workspace.
      • keyName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> keyName()
        Returns:
        Name of the API key. Key names must be unique to the workspace.
      • keyRole

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> keyRole()
        Returns:
        Permission level of the API key. Valid values are `VIEWER`, `EDITOR`, or `ADMIN`.
      • 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.
      • secondsToLive

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> secondsToLive()
        Returns:
        Time in seconds until the API key expires. Keys can be valid for up to 30 days.
      • workspaceId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> workspaceId()
        Returns:
        ID of the workspace that the API key is valid for.