Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. ecs
  5. getCluster

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.ecs.getCluster

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

    The AWS::ECS::Cluster resource creates an Amazon Elastic Container Service (Amazon ECS) cluster.

    Using getCluster

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>
    def get_cluster(cluster_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(cluster_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]
    func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput

    > Note: This function is named LookupCluster in the Go SDK.

    public static class GetCluster 
{
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:ecs:getCluster
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ClusterName string
    A user-generated string that you use to identify your cluster. If you don't specify a name, CFNlong generates a unique physical ID for the name.
    ClusterName string
    A user-generated string that you use to identify your cluster. If you don't specify a name, CFNlong generates a unique physical ID for the name.
    clusterName String
    A user-generated string that you use to identify your cluster. If you don't specify a name, CFNlong generates a unique physical ID for the name.
    clusterName string
    A user-generated string that you use to identify your cluster. If you don't specify a name, CFNlong generates a unique physical ID for the name.
    cluster_name str
    A user-generated string that you use to identify your cluster. If you don't specify a name, CFNlong generates a unique physical ID for the name.
    clusterName String
    A user-generated string that you use to identify your cluster. If you don't specify a name, CFNlong generates a unique physical ID for the name.

    getCluster Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) of the Amazon ECS cluster, such as arn:aws:ecs:us-east-2:123456789012:cluster/MyECSCluster .
    CapacityProviders List<string>
    The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the CreateService or RunTask actions. If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation. To use a FARGATElong capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The FARGATElong capacity providers are available to all accounts and only need to be associated with a cluster to be used. The PutCapacityProvider API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
    ClusterSettings List<Pulumi.AwsNative.Ecs.Outputs.ClusterSettings>
    The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster.
    Configuration Pulumi.AwsNative.Ecs.Outputs.ClusterConfiguration
    The execute command configuration for the cluster.
    DefaultCapacityProviderStrategy List<Pulumi.AwsNative.Ecs.Outputs.ClusterCapacityProviderStrategyItem>
    The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both. The following basic restrictions apply to tags:

    • Maximum number of tags per resource - 50
    • For each resource, each tag key must be unique, and each tag key can have only one value.
    • Maximum key length - 128 Unicode characters in UTF-8
    • Maximum value length - 256 Unicode characters in UTF-8
    • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
    • Tag keys and values are case-sensitive.
    • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
    Arn string
    The Amazon Resource Name (ARN) of the Amazon ECS cluster, such as arn:aws:ecs:us-east-2:123456789012:cluster/MyECSCluster .
    CapacityProviders []string
    The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the CreateService or RunTask actions. If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation. To use a FARGATElong capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The FARGATElong capacity providers are available to all accounts and only need to be associated with a cluster to be used. The PutCapacityProvider API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
    ClusterSettings []ClusterSettings
    The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster.
    Configuration ClusterConfiguration
    The execute command configuration for the cluster.
    DefaultCapacityProviderStrategy []ClusterCapacityProviderStrategyItem
    The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.
    Tags Tag
    The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both. The following basic restrictions apply to tags:

    • Maximum number of tags per resource - 50
    • For each resource, each tag key must be unique, and each tag key can have only one value.
    • Maximum key length - 128 Unicode characters in UTF-8
    • Maximum value length - 256 Unicode characters in UTF-8
    • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
    • Tag keys and values are case-sensitive.
    • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
    arn String
    The Amazon Resource Name (ARN) of the Amazon ECS cluster, such as arn:aws:ecs:us-east-2:123456789012:cluster/MyECSCluster .
    capacityProviders List<String>
    The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the CreateService or RunTask actions. If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation. To use a FARGATElong capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The FARGATElong capacity providers are available to all accounts and only need to be associated with a cluster to be used. The PutCapacityProvider API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
    clusterSettings List<ClusterSettings>
    The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster.
    configuration ClusterConfiguration
    The execute command configuration for the cluster.
    defaultCapacityProviderStrategy List<ClusterCapacityProviderStrategyItem>
    The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.
    tags List<Tag>
    The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both. The following basic restrictions apply to tags:

    • Maximum number of tags per resource - 50
    • For each resource, each tag key must be unique, and each tag key can have only one value.
    • Maximum key length - 128 Unicode characters in UTF-8
    • Maximum value length - 256 Unicode characters in UTF-8
    • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
    • Tag keys and values are case-sensitive.
    • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
    arn string
    The Amazon Resource Name (ARN) of the Amazon ECS cluster, such as arn:aws:ecs:us-east-2:123456789012:cluster/MyECSCluster .
    capacityProviders string[]
    The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the CreateService or RunTask actions. If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation. To use a FARGATElong capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The FARGATElong capacity providers are available to all accounts and only need to be associated with a cluster to be used. The PutCapacityProvider API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
    clusterSettings ClusterSettings[]
    The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster.
    configuration ClusterConfiguration
    The execute command configuration for the cluster.
    defaultCapacityProviderStrategy ClusterCapacityProviderStrategyItem[]
    The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.
    tags Tag[]
    The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both. The following basic restrictions apply to tags:

    • Maximum number of tags per resource - 50
    • For each resource, each tag key must be unique, and each tag key can have only one value.
    • Maximum key length - 128 Unicode characters in UTF-8
    • Maximum value length - 256 Unicode characters in UTF-8
    • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
    • Tag keys and values are case-sensitive.
    • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
    arn str
    The Amazon Resource Name (ARN) of the Amazon ECS cluster, such as arn:aws:ecs:us-east-2:123456789012:cluster/MyECSCluster .
    capacity_providers Sequence[str]
    The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the CreateService or RunTask actions. If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation. To use a FARGATElong capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The FARGATElong capacity providers are available to all accounts and only need to be associated with a cluster to be used. The PutCapacityProvider API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
    cluster_settings Sequence[ClusterSettings]
    The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster.
    configuration ClusterConfiguration
    The execute command configuration for the cluster.
    default_capacity_provider_strategy Sequence[ClusterCapacityProviderStrategyItem]
    The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.
    tags Sequence[root_Tag]
    The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both. The following basic restrictions apply to tags:

    • Maximum number of tags per resource - 50
    • For each resource, each tag key must be unique, and each tag key can have only one value.
    • Maximum key length - 128 Unicode characters in UTF-8
    • Maximum value length - 256 Unicode characters in UTF-8
    • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
    • Tag keys and values are case-sensitive.
    • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
    arn String
    The Amazon Resource Name (ARN) of the Amazon ECS cluster, such as arn:aws:ecs:us-east-2:123456789012:cluster/MyECSCluster .
    capacityProviders List<String>
    The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the CreateService or RunTask actions. If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation. To use a FARGATElong capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The FARGATElong capacity providers are available to all accounts and only need to be associated with a cluster to be used. The PutCapacityProvider API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
    clusterSettings List<Property Map>
    The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster.
    configuration Property Map
    The execute command configuration for the cluster.
    defaultCapacityProviderStrategy List<Property Map>
    The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.
    tags List<Property Map>
    The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both. The following basic restrictions apply to tags:

    • Maximum number of tags per resource - 50
    • For each resource, each tag key must be unique, and each tag key can have only one value.
    • Maximum key length - 128 Unicode characters in UTF-8
    • Maximum value length - 256 Unicode characters in UTF-8
    • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
    • Tag keys and values are case-sensitive.
    • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

    Supporting Types

    ClusterCapacityProviderStrategyItem

    Base int
    The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.
    CapacityProvider string
    The short name of the capacity provider.
    Weight int
    The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied. If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0, any RunTask or CreateService actions using the capacity provider strategy will fail. An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.
    Base int
    The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.
    CapacityProvider string
    The short name of the capacity provider.
    Weight int
    The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied. If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0, any RunTask or CreateService actions using the capacity provider strategy will fail. An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.
    base Integer
    The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.
    capacityProvider String
    The short name of the capacity provider.
    weight Integer
    The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied. If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0, any RunTask or CreateService actions using the capacity provider strategy will fail. An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.
    base number
    The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.
    capacityProvider string
    The short name of the capacity provider.
    weight number
    The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied. If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0, any RunTask or CreateService actions using the capacity provider strategy will fail. An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.
    base int
    The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.
    capacity_provider str
    The short name of the capacity provider.
    weight int
    The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied. If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0, any RunTask or CreateService actions using the capacity provider strategy will fail. An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.
    base Number
    The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined. If no value is specified, the default value of 0 is used.
    capacityProvider String
    The short name of the capacity provider.
    weight Number
    The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The weight value is taken into consideration after the base value, if defined, is satisfied. If no weight value is specified, the default value of 0 is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of 0 can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of 0, any RunTask or CreateService actions using the capacity provider strategy will fail. An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of 1, then when the base is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1 for capacityProviderA and a weight of 4 for capacityProviderB, then for every one task that's run using capacityProviderA, four tasks would use capacityProviderB.

    ClusterConfiguration

    ExecuteCommandConfiguration ClusterExecuteCommandConfiguration
    The details of the execute command configuration.
    ManagedStorageConfiguration ClusterManagedStorageConfiguration
    The details of the managed storage configuration.
    executeCommandConfiguration ClusterExecuteCommandConfiguration
    The details of the execute command configuration.
    managedStorageConfiguration ClusterManagedStorageConfiguration
    The details of the managed storage configuration.
    executeCommandConfiguration ClusterExecuteCommandConfiguration
    The details of the execute command configuration.
    managedStorageConfiguration ClusterManagedStorageConfiguration
    The details of the managed storage configuration.
    execute_command_configuration ClusterExecuteCommandConfiguration
    The details of the execute command configuration.
    managed_storage_configuration ClusterManagedStorageConfiguration
    The details of the managed storage configuration.
    executeCommandConfiguration Property Map
    The details of the execute command configuration.
    managedStorageConfiguration Property Map
    The details of the managed storage configuration.

    ClusterExecuteCommandConfiguration

    KmsKeyId string
    Specify an KMSlong key ID to encrypt the data between the local client and the container.
    LogConfiguration Pulumi.AwsNative.Ecs.Inputs.ClusterExecuteCommandLogConfiguration
    The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When logging=OVERRIDE is specified, a logConfiguration must be provided.
    Logging string
    The log setting to use for redirecting logs for your execute command results. The following log settings are available.

    • NONE: The execute command session is not logged.
    • DEFAULT: The awslogs configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no awslogs log driver is configured in the task definition, the output won't be logged.
    • OVERRIDE: Specify the logging details as a part of logConfiguration. If the OVERRIDE logging option is specified, the logConfiguration is required.
    KmsKeyId string
    Specify an KMSlong key ID to encrypt the data between the local client and the container.
    LogConfiguration ClusterExecuteCommandLogConfiguration
    The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When logging=OVERRIDE is specified, a logConfiguration must be provided.
    Logging string
    The log setting to use for redirecting logs for your execute command results. The following log settings are available.

    • NONE: The execute command session is not logged.
    • DEFAULT: The awslogs configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no awslogs log driver is configured in the task definition, the output won't be logged.
    • OVERRIDE: Specify the logging details as a part of logConfiguration. If the OVERRIDE logging option is specified, the logConfiguration is required.
    kmsKeyId String
    Specify an KMSlong key ID to encrypt the data between the local client and the container.
    logConfiguration ClusterExecuteCommandLogConfiguration
    The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When logging=OVERRIDE is specified, a logConfiguration must be provided.
    logging String
    The log setting to use for redirecting logs for your execute command results. The following log settings are available.

    • NONE: The execute command session is not logged.
    • DEFAULT: The awslogs configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no awslogs log driver is configured in the task definition, the output won't be logged.
    • OVERRIDE: Specify the logging details as a part of logConfiguration. If the OVERRIDE logging option is specified, the logConfiguration is required.
    kmsKeyId string
    Specify an KMSlong key ID to encrypt the data between the local client and the container.
    logConfiguration ClusterExecuteCommandLogConfiguration
    The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When logging=OVERRIDE is specified, a logConfiguration must be provided.
    logging string
    The log setting to use for redirecting logs for your execute command results. The following log settings are available.

    • NONE: The execute command session is not logged.
    • DEFAULT: The awslogs configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no awslogs log driver is configured in the task definition, the output won't be logged.
    • OVERRIDE: Specify the logging details as a part of logConfiguration. If the OVERRIDE logging option is specified, the logConfiguration is required.
    kms_key_id str
    Specify an KMSlong key ID to encrypt the data between the local client and the container.
    log_configuration ClusterExecuteCommandLogConfiguration
    The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When logging=OVERRIDE is specified, a logConfiguration must be provided.
    logging str
    The log setting to use for redirecting logs for your execute command results. The following log settings are available.

    • NONE: The execute command session is not logged.
    • DEFAULT: The awslogs configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no awslogs log driver is configured in the task definition, the output won't be logged.
    • OVERRIDE: Specify the logging details as a part of logConfiguration. If the OVERRIDE logging option is specified, the logConfiguration is required.
    kmsKeyId String
    Specify an KMSlong key ID to encrypt the data between the local client and the container.
    logConfiguration Property Map
    The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When logging=OVERRIDE is specified, a logConfiguration must be provided.
    logging String
    The log setting to use for redirecting logs for your execute command results. The following log settings are available.

    • NONE: The execute command session is not logged.
    • DEFAULT: The awslogs configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no awslogs log driver is configured in the task definition, the output won't be logged.
    • OVERRIDE: Specify the logging details as a part of logConfiguration. If the OVERRIDE logging option is specified, the logConfiguration is required.

    ClusterExecuteCommandLogConfiguration

    CloudWatchEncryptionEnabled bool
    Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off.
    CloudWatchLogGroupName string
    The name of the CloudWatch log group to send logs to. The CloudWatch log group must already be created.
    S3BucketName string
    The name of the S3 bucket to send logs to. The S3 bucket must already be created.
    S3EncryptionEnabled bool
    Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.
    S3KeyPrefix string
    An optional folder in the S3 bucket to place logs in.
    CloudWatchEncryptionEnabled bool
    Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off.
    CloudWatchLogGroupName string
    The name of the CloudWatch log group to send logs to. The CloudWatch log group must already be created.
    S3BucketName string
    The name of the S3 bucket to send logs to. The S3 bucket must already be created.
    S3EncryptionEnabled bool
    Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.
    S3KeyPrefix string
    An optional folder in the S3 bucket to place logs in.
    cloudWatchEncryptionEnabled Boolean
    Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off.
    cloudWatchLogGroupName String
    The name of the CloudWatch log group to send logs to. The CloudWatch log group must already be created.
    s3BucketName String
    The name of the S3 bucket to send logs to. The S3 bucket must already be created.
    s3EncryptionEnabled Boolean
    Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.
    s3KeyPrefix String
    An optional folder in the S3 bucket to place logs in.
    cloudWatchEncryptionEnabled boolean
    Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off.
    cloudWatchLogGroupName string
    The name of the CloudWatch log group to send logs to. The CloudWatch log group must already be created.
    s3BucketName string
    The name of the S3 bucket to send logs to. The S3 bucket must already be created.
    s3EncryptionEnabled boolean
    Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.
    s3KeyPrefix string
    An optional folder in the S3 bucket to place logs in.
    cloud_watch_encryption_enabled bool
    Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off.
    cloud_watch_log_group_name str
    The name of the CloudWatch log group to send logs to. The CloudWatch log group must already be created.
    s3_bucket_name str
    The name of the S3 bucket to send logs to. The S3 bucket must already be created.
    s3_encryption_enabled bool
    Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.
    s3_key_prefix str
    An optional folder in the S3 bucket to place logs in.
    cloudWatchEncryptionEnabled Boolean
    Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off.
    cloudWatchLogGroupName String
    The name of the CloudWatch log group to send logs to. The CloudWatch log group must already be created.
    s3BucketName String
    The name of the S3 bucket to send logs to. The S3 bucket must already be created.
    s3EncryptionEnabled Boolean
    Determines whether to use encryption on the S3 logs. If not specified, encryption is not used.
    s3KeyPrefix String
    An optional folder in the S3 bucket to place logs in.

    ClusterManagedStorageConfiguration

    FargateEphemeralStorageKmsKeyId string
    Specify the AWS Key Management Service key ID for the Fargate ephemeral storage.
    KmsKeyId string
    Specify a AWS Key Management Service key ID to encrypt the managed storage.
    FargateEphemeralStorageKmsKeyId string
    Specify the AWS Key Management Service key ID for the Fargate ephemeral storage.
    KmsKeyId string
    Specify a AWS Key Management Service key ID to encrypt the managed storage.
    fargateEphemeralStorageKmsKeyId String
    Specify the AWS Key Management Service key ID for the Fargate ephemeral storage.
    kmsKeyId String
    Specify a AWS Key Management Service key ID to encrypt the managed storage.
    fargateEphemeralStorageKmsKeyId string
    Specify the AWS Key Management Service key ID for the Fargate ephemeral storage.
    kmsKeyId string
    Specify a AWS Key Management Service key ID to encrypt the managed storage.
    fargate_ephemeral_storage_kms_key_id str
    Specify the AWS Key Management Service key ID for the Fargate ephemeral storage.
    kms_key_id str
    Specify a AWS Key Management Service key ID to encrypt the managed storage.
    fargateEphemeralStorageKmsKeyId String
    Specify the AWS Key Management Service key ID for the Fargate ephemeral storage.
    kmsKeyId String
    Specify a AWS Key Management Service key ID to encrypt the managed storage.

    ClusterSettings

    Name string
    The name of the cluster setting. The value is containerInsights .
    Value string
    The value to set for the cluster setting. The supported values are enabled and disabled. If you set name to containerInsights and value to enabled, CloudWatch Container Insights will be on for the cluster, otherwise it will be off unless the containerInsights account setting is turned on. If a cluster value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.
    Name string
    The name of the cluster setting. The value is containerInsights .
    Value string
    The value to set for the cluster setting. The supported values are enabled and disabled. If you set name to containerInsights and value to enabled, CloudWatch Container Insights will be on for the cluster, otherwise it will be off unless the containerInsights account setting is turned on. If a cluster value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.
    name String
    The name of the cluster setting. The value is containerInsights .
    value String
    The value to set for the cluster setting. The supported values are enabled and disabled. If you set name to containerInsights and value to enabled, CloudWatch Container Insights will be on for the cluster, otherwise it will be off unless the containerInsights account setting is turned on. If a cluster value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.
    name string
    The name of the cluster setting. The value is containerInsights .
    value string
    The value to set for the cluster setting. The supported values are enabled and disabled. If you set name to containerInsights and value to enabled, CloudWatch Container Insights will be on for the cluster, otherwise it will be off unless the containerInsights account setting is turned on. If a cluster value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.
    name str
    The name of the cluster setting. The value is containerInsights .
    value str
    The value to set for the cluster setting. The supported values are enabled and disabled. If you set name to containerInsights and value to enabled, CloudWatch Container Insights will be on for the cluster, otherwise it will be off unless the containerInsights account setting is turned on. If a cluster value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.
    name String
    The name of the cluster setting. The value is containerInsights .
    value String
    The value to set for the cluster setting. The supported values are enabled and disabled. If you set name to containerInsights and value to enabled, CloudWatch Container Insights will be on for the cluster, otherwise it will be off unless the containerInsights account setting is turned on. If a cluster value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native