Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. codeguruprofiler
  5. ProfilingGroup
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.codeguruprofiler.ProfilingGroup

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Resource for managing an AWS CodeGuru Profiler Profiling Group.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.codeguruprofiler.ProfilingGroup("example", {
    name: "example",
    computePlatform: "Default",
    agentOrchestrationConfig: {
        profilingEnabled: true,
    },
});

    import pulumi
import pulumi_aws as aws

example = aws.codeguruprofiler.ProfilingGroup("example",
    name="example",
    compute_platform="Default",
    agent_orchestration_config={
        "profiling_enabled": True,
    })

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/codeguruprofiler"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := codeguruprofiler.NewProfilingGroup(ctx, "example", &codeguruprofiler.ProfilingGroupArgs{
			Name:            pulumi.String("example"),
			ComputePlatform: pulumi.String("Default"),
			AgentOrchestrationConfig: &codeguruprofiler.ProfilingGroupAgentOrchestrationConfigArgs{
				ProfilingEnabled: pulumi.Bool(true),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.CodeGuruProfiler.ProfilingGroup("example", new()
    {
        Name = "example",
        ComputePlatform = "Default",
        AgentOrchestrationConfig = new Aws.CodeGuruProfiler.Inputs.ProfilingGroupAgentOrchestrationConfigArgs
        {
            ProfilingEnabled = true,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.codeguruprofiler.ProfilingGroup;
import com.pulumi.aws.codeguruprofiler.ProfilingGroupArgs;
import com.pulumi.aws.codeguruprofiler.inputs.ProfilingGroupAgentOrchestrationConfigArgs;
import java.util.List;
import java.util.ArrayList;
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 ProfilingGroup("example", ProfilingGroupArgs.builder()
            .name("example")
            .computePlatform("Default")
            .agentOrchestrationConfig(ProfilingGroupAgentOrchestrationConfigArgs.builder()
                .profilingEnabled(true)
                .build())
            .build());

    }
}

    resources:
  example:
    type: aws:codeguruprofiler:ProfilingGroup
    properties:
      name: example
      computePlatform: Default
      agentOrchestrationConfig:
        profilingEnabled: true

    Create ProfilingGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ProfilingGroup(name: string, args?: ProfilingGroupArgs, opts?: CustomResourceOptions);
    @overload
def ProfilingGroup(resource_name: str,
                   args: Optional[ProfilingGroupArgs] = None,
                   opts: Optional[ResourceOptions] = None)

@overload
def ProfilingGroup(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   agent_orchestration_config: Optional[ProfilingGroupAgentOrchestrationConfigArgs] = None,
                   compute_platform: Optional[str] = None,
                   name: Optional[str] = None,
                   tags: Optional[Mapping[str, str]] = None)
    func NewProfilingGroup(ctx *Context, name string, args *ProfilingGroupArgs, opts ...ResourceOption) (*ProfilingGroup, error)
    public ProfilingGroup(string name, ProfilingGroupArgs? args = null, CustomResourceOptions? opts = null)
    public ProfilingGroup(String name, ProfilingGroupArgs args)
public ProfilingGroup(String name, ProfilingGroupArgs args, CustomResourceOptions options)

    type: aws:codeguruprofiler:ProfilingGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ProfilingGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ProfilingGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ProfilingGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProfilingGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProfilingGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var profilingGroupResource = new Aws.CodeGuruProfiler.ProfilingGroup("profilingGroupResource", new()
{
    AgentOrchestrationConfig = new Aws.CodeGuruProfiler.Inputs.ProfilingGroupAgentOrchestrationConfigArgs
    {
        ProfilingEnabled = false,
    },
    ComputePlatform = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := codeguruprofiler.NewProfilingGroup(ctx, "profilingGroupResource", &codeguruprofiler.ProfilingGroupArgs{
	AgentOrchestrationConfig: &codeguruprofiler.ProfilingGroupAgentOrchestrationConfigArgs{
		ProfilingEnabled: pulumi.Bool(false),
	},
	ComputePlatform: pulumi.String("string"),
	Name:            pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var profilingGroupResource = new ProfilingGroup("profilingGroupResource", ProfilingGroupArgs.builder()
    .agentOrchestrationConfig(ProfilingGroupAgentOrchestrationConfigArgs.builder()
        .profilingEnabled(false)
        .build())
    .computePlatform("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

    profiling_group_resource = aws.codeguruprofiler.ProfilingGroup("profilingGroupResource",
    agent_orchestration_config={
        "profiling_enabled": False,
    },
    compute_platform="string",
    name="string",
    tags={
        "string": "string",
    })

    const profilingGroupResource = new aws.codeguruprofiler.ProfilingGroup("profilingGroupResource", {
    agentOrchestrationConfig: {
        profilingEnabled: false,
    },
    computePlatform: "string",
    name: "string",
    tags: {
        string: "string",
    },
});

    type: aws:codeguruprofiler:ProfilingGroup
properties:
    agentOrchestrationConfig:
        profilingEnabled: false
    computePlatform: string
    name: string
    tags:
        string: string

    ProfilingGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ProfilingGroup resource accepts the following input properties:

    AgentOrchestrationConfig ProfilingGroupAgentOrchestrationConfig
    Specifies whether profiling is enabled or disabled for the created profiling. See Agent Orchestration Config for more details.
    ComputePlatform string
    Compute platform of the profiling group.
    Name string

    Name of the profiling group.

    The following arguments are optional:

    Tags Dictionary<string, string>
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    AgentOrchestrationConfig ProfilingGroupAgentOrchestrationConfigArgs
    Specifies whether profiling is enabled or disabled for the created profiling. See Agent Orchestration Config for more details.
    ComputePlatform string
    Compute platform of the profiling group.
    Name string

    Name of the profiling group.

    The following arguments are optional:

    Tags map[string]string
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    agentOrchestrationConfig ProfilingGroupAgentOrchestrationConfig
    Specifies whether profiling is enabled or disabled for the created profiling. See Agent Orchestration Config for more details.
    computePlatform String
    Compute platform of the profiling group.
    name String

    Name of the profiling group.

    The following arguments are optional:

    tags Map<String,String>
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    agentOrchestrationConfig ProfilingGroupAgentOrchestrationConfig
    Specifies whether profiling is enabled or disabled for the created profiling. See Agent Orchestration Config for more details.
    computePlatform string
    Compute platform of the profiling group.
    name string

    Name of the profiling group.

    The following arguments are optional:

    tags {[key: string]: string}
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    agent_orchestration_config ProfilingGroupAgentOrchestrationConfigArgs
    Specifies whether profiling is enabled or disabled for the created profiling. See Agent Orchestration Config for more details.
    compute_platform str
    Compute platform of the profiling group.
    name str

    Name of the profiling group.

    The following arguments are optional:

    tags Mapping[str, str]
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    agentOrchestrationConfig Property Map
    Specifies whether profiling is enabled or disabled for the created profiling. See Agent Orchestration Config for more details.
    computePlatform String
    Compute platform of the profiling group.
    name String

    Name of the profiling group.

    The following arguments are optional:

    tags Map<String>
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ProfilingGroup resource produces the following output properties:

    Arn string
    ARN of the profiling group.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN of the profiling group.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the profiling group.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN of the profiling group.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN of the profiling group.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the profiling group.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing ProfilingGroup Resource

    Get an existing ProfilingGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ProfilingGroupState, opts?: CustomResourceOptions): ProfilingGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        agent_orchestration_config: Optional[ProfilingGroupAgentOrchestrationConfigArgs] = None,
        arn: Optional[str] = None,
        compute_platform: Optional[str] = None,
        name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> ProfilingGroup
    func GetProfilingGroup(ctx *Context, name string, id IDInput, state *ProfilingGroupState, opts ...ResourceOption) (*ProfilingGroup, error)
    public static ProfilingGroup Get(string name, Input<string> id, ProfilingGroupState? state, CustomResourceOptions? opts = null)
    public static ProfilingGroup get(String name, Output<String> id, ProfilingGroupState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AgentOrchestrationConfig ProfilingGroupAgentOrchestrationConfig
    Specifies whether profiling is enabled or disabled for the created profiling. See Agent Orchestration Config for more details.
    Arn string
    ARN of the profiling group.
    ComputePlatform string
    Compute platform of the profiling group.
    Name string

    Name of the profiling group.

    The following arguments are optional:

    Tags Dictionary<string, string>
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    AgentOrchestrationConfig ProfilingGroupAgentOrchestrationConfigArgs
    Specifies whether profiling is enabled or disabled for the created profiling. See Agent Orchestration Config for more details.
    Arn string
    ARN of the profiling group.
    ComputePlatform string
    Compute platform of the profiling group.
    Name string

    Name of the profiling group.

    The following arguments are optional:

    Tags map[string]string
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    agentOrchestrationConfig ProfilingGroupAgentOrchestrationConfig
    Specifies whether profiling is enabled or disabled for the created profiling. See Agent Orchestration Config for more details.
    arn String
    ARN of the profiling group.
    computePlatform String
    Compute platform of the profiling group.
    name String

    Name of the profiling group.

    The following arguments are optional:

    tags Map<String,String>
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    agentOrchestrationConfig ProfilingGroupAgentOrchestrationConfig
    Specifies whether profiling is enabled or disabled for the created profiling. See Agent Orchestration Config for more details.
    arn string
    ARN of the profiling group.
    computePlatform string
    Compute platform of the profiling group.
    name string

    Name of the profiling group.

    The following arguments are optional:

    tags {[key: string]: string}
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    agent_orchestration_config ProfilingGroupAgentOrchestrationConfigArgs
    Specifies whether profiling is enabled or disabled for the created profiling. See Agent Orchestration Config for more details.
    arn str
    ARN of the profiling group.
    compute_platform str
    Compute platform of the profiling group.
    name str

    Name of the profiling group.

    The following arguments are optional:

    tags Mapping[str, str]
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    agentOrchestrationConfig Property Map
    Specifies whether profiling is enabled or disabled for the created profiling. See Agent Orchestration Config for more details.
    arn String
    ARN of the profiling group.
    computePlatform String
    Compute platform of the profiling group.
    name String

    Name of the profiling group.

    The following arguments are optional:

    tags Map<String>
    Map of tags assigned to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Supporting Types

    ProfilingGroupAgentOrchestrationConfig, ProfilingGroupAgentOrchestrationConfigArgs

    ProfilingEnabled bool
    (Required) Boolean that specifies whether the profiling agent collects profiling data or
    ProfilingEnabled bool
    (Required) Boolean that specifies whether the profiling agent collects profiling data or
    profilingEnabled Boolean
    (Required) Boolean that specifies whether the profiling agent collects profiling data or
    profilingEnabled boolean
    (Required) Boolean that specifies whether the profiling agent collects profiling data or
    profiling_enabled bool
    (Required) Boolean that specifies whether the profiling agent collects profiling data or
    profilingEnabled Boolean
    (Required) Boolean that specifies whether the profiling agent collects profiling data or

    Import

    Using pulumi import, import CodeGuru Profiler Profiling Group using the id. For example:

    $ pulumi import aws:codeguruprofiler/profilingGroup:ProfilingGroup example profiling_group-name-12345678

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws