Docs Packages
  1. Packages
  2. CockroachDB Cloud
  3. API Docs
  4. MetricExportCloudwatchConfig
CockroachDB v0.2.3 published on Monday, May 27, 2024 by pulumiverse
pulumiverse/pulumi-cockroach

cockroach.MetricExportCloudwatchConfig

Explore with Pulumi AI

cockroach logo
CockroachDB v0.2.3 published on Monday, May 27, 2024 by pulumiverse
pulumiverse/pulumi-cockroach

    Amazon CloudWatch metric export configuration for a cluster.

    Create MetricExportCloudwatchConfig Resource

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

    Constructor syntax

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

@overload
def MetricExportCloudwatchConfig(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 cluster_id: Optional[str] = None,
                                 role_arn: Optional[str] = None,
                                 log_group_name: Optional[str] = None,
                                 target_region: Optional[str] = None)
    func NewMetricExportCloudwatchConfig(ctx *Context, name string, args MetricExportCloudwatchConfigArgs, opts ...ResourceOption) (*MetricExportCloudwatchConfig, error)
    public MetricExportCloudwatchConfig(string name, MetricExportCloudwatchConfigArgs args, CustomResourceOptions? opts = null)
    public MetricExportCloudwatchConfig(String name, MetricExportCloudwatchConfigArgs args)
public MetricExportCloudwatchConfig(String name, MetricExportCloudwatchConfigArgs args, CustomResourceOptions options)

    type: cockroach:MetricExportCloudwatchConfig
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 MetricExportCloudwatchConfigArgs
    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 MetricExportCloudwatchConfigArgs
    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 MetricExportCloudwatchConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MetricExportCloudwatchConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MetricExportCloudwatchConfigArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var metricExportCloudwatchConfigResource = new Cockroach.MetricExportCloudwatchConfig("metricExportCloudwatchConfigResource", new()
{
    ClusterId = "string",
    RoleArn = "string",
    LogGroupName = "string",
    TargetRegion = "string",
});

    example, err := cockroach.NewMetricExportCloudwatchConfig(ctx, "metricExportCloudwatchConfigResource", &cockroach.MetricExportCloudwatchConfigArgs{
	ClusterId:    pulumi.String("string"),
	RoleArn:      pulumi.String("string"),
	LogGroupName: pulumi.String("string"),
	TargetRegion: pulumi.String("string"),
})

    var metricExportCloudwatchConfigResource = new MetricExportCloudwatchConfig("metricExportCloudwatchConfigResource", MetricExportCloudwatchConfigArgs.builder()
    .clusterId("string")
    .roleArn("string")
    .logGroupName("string")
    .targetRegion("string")
    .build());

    metric_export_cloudwatch_config_resource = cockroach.MetricExportCloudwatchConfig("metricExportCloudwatchConfigResource",
    cluster_id="string",
    role_arn="string",
    log_group_name="string",
    target_region="string")

    const metricExportCloudwatchConfigResource = new cockroach.MetricExportCloudwatchConfig("metricExportCloudwatchConfigResource", {
    clusterId: "string",
    roleArn: "string",
    logGroupName: "string",
    targetRegion: "string",
});

    type: cockroach:MetricExportCloudwatchConfig
properties:
    clusterId: string
    logGroupName: string
    roleArn: string
    targetRegion: string

    MetricExportCloudwatchConfig Resource Properties

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

    Inputs

    The MetricExportCloudwatchConfig resource accepts the following input properties:

    ClusterId string
    Cluster ID.
    RoleArn string
    The IAM role used to upload metric segments to the target AWS account.
    LogGroupName string
    The customized AWS CloudWatch log group name.
    TargetRegion string
    The specific AWS region that the metrics will be exported to.
    ClusterId string
    Cluster ID.
    RoleArn string
    The IAM role used to upload metric segments to the target AWS account.
    LogGroupName string
    The customized AWS CloudWatch log group name.
    TargetRegion string
    The specific AWS region that the metrics will be exported to.
    clusterId String
    Cluster ID.
    roleArn String
    The IAM role used to upload metric segments to the target AWS account.
    logGroupName String
    The customized AWS CloudWatch log group name.
    targetRegion String
    The specific AWS region that the metrics will be exported to.
    clusterId string
    Cluster ID.
    roleArn string
    The IAM role used to upload metric segments to the target AWS account.
    logGroupName string
    The customized AWS CloudWatch log group name.
    targetRegion string
    The specific AWS region that the metrics will be exported to.
    cluster_id str
    Cluster ID.
    role_arn str
    The IAM role used to upload metric segments to the target AWS account.
    log_group_name str
    The customized AWS CloudWatch log group name.
    target_region str
    The specific AWS region that the metrics will be exported to.
    clusterId String
    Cluster ID.
    roleArn String
    The IAM role used to upload metric segments to the target AWS account.
    logGroupName String
    The customized AWS CloudWatch log group name.
    targetRegion String
    The specific AWS region that the metrics will be exported to.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Encodes the possible states that a metric export configuration can be in as it is created, deployed, and disabled.
    UserMessage string
    Elaborates on the metric export status and hints at how to fix issues that may have occurred during asynchronous operations.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Encodes the possible states that a metric export configuration can be in as it is created, deployed, and disabled.
    UserMessage string
    Elaborates on the metric export status and hints at how to fix issues that may have occurred during asynchronous operations.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Encodes the possible states that a metric export configuration can be in as it is created, deployed, and disabled.
    userMessage String
    Elaborates on the metric export status and hints at how to fix issues that may have occurred during asynchronous operations.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    Encodes the possible states that a metric export configuration can be in as it is created, deployed, and disabled.
    userMessage string
    Elaborates on the metric export status and hints at how to fix issues that may have occurred during asynchronous operations.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    Encodes the possible states that a metric export configuration can be in as it is created, deployed, and disabled.
    user_message str
    Elaborates on the metric export status and hints at how to fix issues that may have occurred during asynchronous operations.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Encodes the possible states that a metric export configuration can be in as it is created, deployed, and disabled.
    userMessage String
    Elaborates on the metric export status and hints at how to fix issues that may have occurred during asynchronous operations.

    Look up Existing MetricExportCloudwatchConfig Resource

    Get an existing MetricExportCloudwatchConfig 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?: MetricExportCloudwatchConfigState, opts?: CustomResourceOptions): MetricExportCloudwatchConfig
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_id: Optional[str] = None,
        log_group_name: Optional[str] = None,
        role_arn: Optional[str] = None,
        status: Optional[str] = None,
        target_region: Optional[str] = None,
        user_message: Optional[str] = None) -> MetricExportCloudwatchConfig
    func GetMetricExportCloudwatchConfig(ctx *Context, name string, id IDInput, state *MetricExportCloudwatchConfigState, opts ...ResourceOption) (*MetricExportCloudwatchConfig, error)
    public static MetricExportCloudwatchConfig Get(string name, Input<string> id, MetricExportCloudwatchConfigState? state, CustomResourceOptions? opts = null)
    public static MetricExportCloudwatchConfig get(String name, Output<String> id, MetricExportCloudwatchConfigState 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:
    ClusterId string
    Cluster ID.
    LogGroupName string
    The customized AWS CloudWatch log group name.
    RoleArn string
    The IAM role used to upload metric segments to the target AWS account.
    Status string
    Encodes the possible states that a metric export configuration can be in as it is created, deployed, and disabled.
    TargetRegion string
    The specific AWS region that the metrics will be exported to.
    UserMessage string
    Elaborates on the metric export status and hints at how to fix issues that may have occurred during asynchronous operations.
    ClusterId string
    Cluster ID.
    LogGroupName string
    The customized AWS CloudWatch log group name.
    RoleArn string
    The IAM role used to upload metric segments to the target AWS account.
    Status string
    Encodes the possible states that a metric export configuration can be in as it is created, deployed, and disabled.
    TargetRegion string
    The specific AWS region that the metrics will be exported to.
    UserMessage string
    Elaborates on the metric export status and hints at how to fix issues that may have occurred during asynchronous operations.
    clusterId String
    Cluster ID.
    logGroupName String
    The customized AWS CloudWatch log group name.
    roleArn String
    The IAM role used to upload metric segments to the target AWS account.
    status String
    Encodes the possible states that a metric export configuration can be in as it is created, deployed, and disabled.
    targetRegion String
    The specific AWS region that the metrics will be exported to.
    userMessage String
    Elaborates on the metric export status and hints at how to fix issues that may have occurred during asynchronous operations.
    clusterId string
    Cluster ID.
    logGroupName string
    The customized AWS CloudWatch log group name.
    roleArn string
    The IAM role used to upload metric segments to the target AWS account.
    status string
    Encodes the possible states that a metric export configuration can be in as it is created, deployed, and disabled.
    targetRegion string
    The specific AWS region that the metrics will be exported to.
    userMessage string
    Elaborates on the metric export status and hints at how to fix issues that may have occurred during asynchronous operations.
    cluster_id str
    Cluster ID.
    log_group_name str
    The customized AWS CloudWatch log group name.
    role_arn str
    The IAM role used to upload metric segments to the target AWS account.
    status str
    Encodes the possible states that a metric export configuration can be in as it is created, deployed, and disabled.
    target_region str
    The specific AWS region that the metrics will be exported to.
    user_message str
    Elaborates on the metric export status and hints at how to fix issues that may have occurred during asynchronous operations.
    clusterId String
    Cluster ID.
    logGroupName String
    The customized AWS CloudWatch log group name.
    roleArn String
    The IAM role used to upload metric segments to the target AWS account.
    status String
    Encodes the possible states that a metric export configuration can be in as it is created, deployed, and disabled.
    targetRegion String
    The specific AWS region that the metrics will be exported to.
    userMessage String
    Elaborates on the metric export status and hints at how to fix issues that may have occurred during asynchronous operations.

    Package Details

    Repository
    cockroach pulumiverse/pulumi-cockroach
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cockroach Terraform Provider.
    cockroach logo
    CockroachDB v0.2.3 published on Monday, May 27, 2024 by pulumiverse
    pulumiverse/pulumi-cockroach