Scope class
Manages a Network Flow Monitor Scope.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const current = aws.getCallerIdentity({});
const example = new aws.networkflowmonitor.Scope("example", {
targets: [{
targetIdentifier: {
targetId: {
accountId: current.then(current => current.accountId),
},
targetType: "ACCOUNT",
},
region: "us-east-1",
}],
tags: {
Name: "example",
},
});
import pulumi
import pulumi_aws as aws
current = aws.get_caller_identity()
example = aws.networkflowmonitor.Scope("example",
targets=[{
"target_identifier": {
"target_id": {
"account_id": current.account_id,
},
"target_type": "ACCOUNT",
},
"region": "us-east-1",
}],
tags={
"Name": "example",
})
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var current = Aws.GetCallerIdentity.Invoke();
var example = new Aws.Networkflowmonitor.Scope("example", new()
{
Targets = new[]
{
new Aws.Networkflowmonitor.Inputs.ScopeTargetArgs
{
TargetIdentifier = new Aws.Networkflowmonitor.Inputs.ScopeTargetTargetIdentifierArgs
{
TargetId = new Aws.Networkflowmonitor.Inputs.ScopeTargetTargetIdentifierTargetIdArgs
{
AccountId = current.Apply(getCallerIdentityResult => getCallerIdentityResult.AccountId),
},
TargetType = "ACCOUNT",
},
Region = "us-east-1",
},
},
Tags =
{
{ "Name", "example" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/networkflowmonitor"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
current, err := aws.GetCallerIdentity(ctx, &aws.GetCallerIdentityArgs{}, nil)
if err != nil {
return err
}
_, err = networkflowmonitor.NewScope(ctx, "example", &networkflowmonitor.ScopeArgs{
Targets: networkflowmonitor.ScopeTargetArray{
&networkflowmonitor.ScopeTargetArgs{
TargetIdentifier: &networkflowmonitor.ScopeTargetTargetIdentifierArgs{
TargetId: &networkflowmonitor.ScopeTargetTargetIdentifierTargetIdArgs{
AccountId: pulumi.String(current.AccountId),
},
TargetType: pulumi.String("ACCOUNT"),
},
Region: pulumi.String("us-east-1"),
},
},
Tags: pulumi.StringMap{
"Name": pulumi.String("example"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_getcalleridentity" "current" {
}
resource "aws_networkflowmonitor_scope" "example" {
targets {
target_identifier = {
target_id = {
account_id = data.aws_getcalleridentity.current.account_id
}
target_type = "ACCOUNT"
}
region = "us-east-1"
}
tags = {
"Name" = "example"
}
}
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());
}
}
resources:
example:
type: aws:networkflowmonitor:Scope
properties:
targets:
- targetIdentifier:
targetId:
accountId: ${current.accountId}
targetType: ACCOUNT
region: us-east-1
tags:
Name: example
variables:
current:
fn::invoke:
function: aws:getCallerIdentity
arguments: {}
Import
Using pulumi import, import Network Flow Monitor Scope using the scope ID. For example:
$ pulumi import aws:networkflowmonitor/scope:Scope example example-scope-id
Constructors
- Scope(String name, {ScopeArgs? args, CustomResourceOptions? options})
-
Creates a new Scope.
nameThe Pulumi resource name.argsArguments used to configure this Scope. The set of arguments for Scope.optionsResource options controlling this resource's behavior. - Scope.reference(String urn)
- Creates a typed reference to an existing Scope resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
scopeArn
↔ Output<
String> -
ARN of the scope.
latefinal
-
scopeId
↔ Output<
String> -
The identifier for the scope that includes the resources you want to get data results for.
latefinal
-
A map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
targets
↔ Output<
List< ScopeTarget> > -
The targets to define the scope to be monitored. A target is an array of target resources, which are currently Region-account pairs.
latefinal
-
timeouts
↔ Output<
ScopeTimeouts?> -
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited