Package com.pulumi.aws.securityhub

Class ConnectorV2

  • public class ConnectorV2
extends com.pulumi.resources.CustomResource
    Manages a Security Hub V2 connector. > **NOTE:** Connectors must be created in the aggregation (home) region. A Security Hub V2 Aggregator (`aws.securityhub.AggregatorV2`) must exist before creating connectors. > **NOTE:** After creation, the connector will be in `PENDING_AUTHORIZATION` status. Use the `authUrl` output to complete the OAuth authorization flow. ## Example Usage ### Jira Cloud 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.securityhub.AccountV2;
 import com.pulumi.aws.securityhub.AggregatorV2;
 import com.pulumi.aws.securityhub.AggregatorV2Args;
 import com.pulumi.aws.securityhub.ConnectorV2;
 import com.pulumi.aws.securityhub.ConnectorV2Args;
 import com.pulumi.aws.securityhub.inputs.ConnectorV2ConnectorProviderArgs;
 import com.pulumi.aws.securityhub.inputs.ConnectorV2ConnectorProviderJiraCloudArgs;
 import com.pulumi.resources.CustomResourceOptions;
 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 AccountV2("example");
 
         var exampleAggregatorV2 = new AggregatorV2("exampleAggregatorV2", AggregatorV2Args.builder()
             .regionLinkingMode("ALL_REGIONS")
             .build(), CustomResourceOptions.builder()
                 .dependsOn(example)
                 .build());
 
         var exampleConnectorV2 = new ConnectorV2("exampleConnectorV2", ConnectorV2Args.builder()
             .connectorProvider(ConnectorV2ConnectorProviderArgs.builder()
                 .jiraCloud(ConnectorV2ConnectorProviderJiraCloudArgs.builder()
                     .projectKey("SEC")
                     .build())
                 .build())
             .name("jira-connector")
             .build(), CustomResourceOptions.builder()
                 .dependsOn(exampleAggregatorV2)
                 .build());
 
         ctx.export("authUrl", exampleConnectorV2.authUrl());
     }
 }
    ### With Description and KMS Key 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.securityhub.ConnectorV2;
 import com.pulumi.aws.securityhub.ConnectorV2Args;
 import com.pulumi.aws.securityhub.inputs.ConnectorV2ConnectorProviderArgs;
 import com.pulumi.aws.securityhub.inputs.ConnectorV2ConnectorProviderJiraCloudArgs;
 import com.pulumi.resources.CustomResourceOptions;
 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 ConnectorV2("example", ConnectorV2Args.builder()
             .connectorProvider(ConnectorV2ConnectorProviderArgs.builder()
                 .jiraCloud(ConnectorV2ConnectorProviderJiraCloudArgs.builder()
                     .projectKey("SEC")
                     .build())
                 .build())
             .name("jira-connector")
             .description("Jira Cloud integration for security findings")
             .kmsKeyArn(exampleAwsKmsKey.arn())
             .build(), CustomResourceOptions.builder()
                 .dependsOn(exampleAwsSecurityhubAggregatorV2)
                 .build());
 
     }
 }
    ## Import ### Identity Schema #### Required * `connectorId` (String) ID of the Security Hub V2 connector. #### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import Security Hub V2 connectors using `connectorId`. For example: ```sh $ pulumi import aws:securityhub/connectorV2:ConnectorV2 example 8ecf045f-5a95-c24d-6769-5d52f6929563 ```

    • 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> arn()  
      com.pulumi.core.Output<java.lang.String> connectorId()  
      com.pulumi.core.Output<ConnectorV2ConnectorProvider> connectorProvider()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      static ConnectorV2 get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ConnectorV2State 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.List<ConnectorV2Health>> healths()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> kmsKeyArn()  
      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()  

      • 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

      • ConnectorV2

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

      • ConnectorV2

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

      • ConnectorV2

        public ConnectorV2​(java.lang.String name,
                   ConnectorV2Args 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

      • arn

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

      • connectorId

        public com.pulumi.core.Output<java.lang.String> connectorId()
        Returns:
        ID of the connector.

      • connectorProvider

        public com.pulumi.core.Output<ConnectorV2ConnectorProvider> connectorProvider()
        Returns:
        Third-party provider details. See `connectorProvider` below.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        A description of the connector.

      • healths

        public com.pulumi.core.Output<java.util.List<ConnectorV2Health>> healths()
        Returns:
        Current health status. See `health` below.

      • kmsKeyArn

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> kmsKeyArn()
        Returns:
        ARN of KMS key for connector encryption.

      • name

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

      • 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 to assign 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.

      • get

        public static ConnectorV2 get​(java.lang.String name,
                              com.pulumi.core.Output<java.lang.String> id,
                              @Nullable
                              ConnectorV2State 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.