Class AgentSpace


  • public class AgentSpace
    extends com.pulumi.resources.CustomResource
    Manages an AWS DevOps Agent Space. ## Example Usage ### Basic Usage
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.devopsagent.AgentSpace;
     import com.pulumi.aws.devopsagent.AgentSpaceArgs;
     import java.util.ArrayList;
     import java.util.Arrays;
     import java.util.Map;
     import java.io.File;
     import java.nio.file.Files;
     import java.nio.file.Paths;
     
     public class App {
         public static void main(String[] args) {
             Pulumi.run(App::stack);
         }
     
         public static void stack(Context ctx) {
             var example = new AgentSpace("example", AgentSpaceArgs.builder()
                 .name("my-agent-space")
                 .build());
     
         }
     }
     
     
    ### With Description and Tags
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.devopsagent.AgentSpace;
     import com.pulumi.aws.devopsagent.AgentSpaceArgs;
     import java.util.ArrayList;
     import java.util.Arrays;
     import java.util.Map;
     import java.io.File;
     import java.nio.file.Files;
     import java.nio.file.Paths;
     
     public class App {
         public static void main(String[] args) {
             Pulumi.run(App::stack);
         }
     
         public static void stack(Context ctx) {
             var example = new AgentSpace("example", AgentSpaceArgs.builder()
                 .name("my-agent-space")
                 .description("An example agent space")
                 .tags(Map.of("Environment", "production"))
                 .build());
     
         }
     }
     
     
    ### With KMS Encryption The KMS key must allow the calling identity and the DevOps Agent service principal to use it. Configure the key policy as described in the [AWS DevOps Agent encryption documentation](https://docs.aws.amazon.com/devopsagent/latest/userguide/aws-devops-agent-security-encryption-at-rest-for-devops-agent.html#step-2-set-the-key-policy) before using this example.
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.devopsagent.AgentSpace;
     import com.pulumi.aws.devopsagent.AgentSpaceArgs;
     import java.util.ArrayList;
     import java.util.Arrays;
     import java.util.Map;
     import java.io.File;
     import java.nio.file.Files;
     import java.nio.file.Paths;
     
     public class App {
         public static void main(String[] args) {
             Pulumi.run(App::stack);
         }
     
         public static void stack(Context ctx) {
             var example = new AgentSpace("example", AgentSpaceArgs.builder()
                 .name("my-agent-space")
                 .kmsKeyArn(exampleAwsKmsKey.arn())
                 .build());
     
         }
     }
     
     
    ## Import ### Identity Schema #### Required * `agentSpaceId` (String) Unique identifier of the Agent Space. #### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import DevOps Agent Space using the `agentSpaceId`. For example: ```sh $ pulumi import aws:devopsagent/agentSpace:AgentSpace example 08975e27-f587-49ca-b7b8-2e1019783803 ```
    • Nested Class Summary

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

        com.pulumi.resources.CustomResource.CustomResourceInternal
      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal
    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> agentSpaceId()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> createdAt()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      static AgentSpace get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, AgentSpaceState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> kmsKeyArn()  
      com.pulumi.core.Output<java.lang.String> locale()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.lang.String> updatedAt()  
      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture
      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • AgentSpace

        public AgentSpace​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.
      • AgentSpace

        public AgentSpace​(java.lang.String name,
                          @Nullable
                          AgentSpaceArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
      • AgentSpace

        public AgentSpace​(java.lang.String name,
                          @Nullable
                          AgentSpaceArgs args,
                          @Nullable
                          com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.
    • Method Detail

      • agentSpaceId

        public com.pulumi.core.Output<java.lang.String> agentSpaceId()
        Returns:
        Unique identifier of the Agent Space.
      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the Agent Space.
      • createdAt

        public com.pulumi.core.Output<java.lang.String> createdAt()
        Returns:
        Timestamp when the Agent Space was created.
      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description of the Agent Space.
      • kmsKeyArn

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> kmsKeyArn()
        Returns:
        ARN of the AWS KMS key used to encrypt resources. Forces new resource.
      • locale

        public com.pulumi.core.Output<java.lang.String> locale()
        Returns:
        Locale for the Agent Space, which determines the language used in agent responses (e.g., `en`).
      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the Agent Space. The following arguments are optional:
      • region

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

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

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

        public com.pulumi.core.Output<java.lang.String> updatedAt()
        Returns:
        Timestamp when the Agent Space was last updated.
      • get

        public static AgentSpace get​(java.lang.String name,
                                     com.pulumi.core.Output<java.lang.String> id,
                                     @Nullable
                                     AgentSpaceState state,
                                     @Nullable
                                     com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.