Class Scope


  • public class Scope
    extends com.pulumi.resources.CustomResource
    Manages a Network Flow Monitor Scope. ## Example Usage ### Basic Usage
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.AwsFunctions;
     import com.pulumi.aws.inputs.GetCallerIdentityArgs;
     import com.pulumi.aws.networkflowmonitor.Scope;
     import com.pulumi.aws.networkflowmonitor.ScopeArgs;
     import com.pulumi.aws.networkflowmonitor.inputs.ScopeTargetArgs;
     import com.pulumi.aws.networkflowmonitor.inputs.ScopeTargetTargetIdentifierArgs;
     import com.pulumi.aws.networkflowmonitor.inputs.ScopeTargetTargetIdentifierTargetIdArgs;
     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) {
             final var current = AwsFunctions.getCallerIdentity(GetCallerIdentityArgs.builder()
                 .build());
     
             var example = new Scope("example", ScopeArgs.builder()
                 .targets(ScopeTargetArgs.builder()
                     .targetIdentifier(ScopeTargetTargetIdentifierArgs.builder()
                         .targetId(ScopeTargetTargetIdentifierTargetIdArgs.builder()
                             .accountId(current.accountId())
                             .build())
                         .targetType("ACCOUNT")
                         .build())
                     .region("us-east-1")
                     .build())
                 .tags(Map.of("Name", "example"))
                 .build());
     
         }
     }
     
     
    ## Import Using `pulumi import`, import Network Flow Monitor Scope using the scope ID. For example: ```sh $ pulumi import aws:networkflowmonitor/scope:Scope example example-scope-id ```
    • 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
    • Constructor Summary

      Constructors 
      Constructor Description
      Scope​(java.lang.String name)  
      Scope​(java.lang.String name, ScopeArgs args)  
      Scope​(java.lang.String name, ScopeArgs args, com.pulumi.resources.CustomResourceOptions options)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static Scope get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ScopeState 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.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> scopeArn()  
      com.pulumi.core.Output<java.lang.String> scopeId()  
      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.util.List<ScopeTarget>> targets()  
      com.pulumi.core.Output<java.util.Optional<ScopeTimeouts>> timeouts()  
      • 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

      • Scope

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

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

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

      • 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.
      • scopeArn

        public com.pulumi.core.Output<java.lang.String> scopeArn()
        Returns:
        ARN of the scope.
      • scopeId

        public com.pulumi.core.Output<java.lang.String> scopeId()
        Returns:
        The identifier for the scope that includes the resources you want to get data results for.
      • tags

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

        public com.pulumi.core.Output<java.util.List<ScopeTarget>> targets()
        Returns:
        The targets to define the scope to be monitored. A target is an array of target resources, which are currently Region-account pairs. The following arguments are optional:
      • timeouts

        public com.pulumi.core.Output<java.util.Optional<ScopeTimeouts>> timeouts()
      • get

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