Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. StreamInstance
MongoDB Atlas v3.18.0 published on Thursday, Sep 12, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.StreamInstance

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.18.0 published on Thursday, Sep 12, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

    # Resource: mongodbatlas.StreamInstance

    mongodbatlas.StreamInstance provides a Stream Instance resource. The resource lets you create, edit, and delete stream instances in a project.

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.StreamInstance;
import com.pulumi.mongodbatlas.StreamInstanceArgs;
import com.pulumi.mongodbatlas.inputs.StreamInstanceDataProcessRegionArgs;
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 test = new StreamInstance("test", StreamInstanceArgs.builder()
            .projectId(projectId)
            .instanceName("InstanceName")
            .dataProcessRegion(StreamInstanceDataProcessRegionArgs.builder()
                .region("VIRGINIA_USA")
                .cloud_provider("AWS")
                .build())
            .build());

    }
}

    resources:
  test:
    type: mongodbatlas:StreamInstance
    properties:
      projectId: ${projectId}
      instanceName: InstanceName
      dataProcessRegion:
        region: VIRGINIA_USA
        cloud_provider: AWS

    Create StreamInstance Resource

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

    Constructor syntax

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

@overload
def StreamInstance(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   data_process_region: Optional[StreamInstanceDataProcessRegionArgs] = None,
                   instance_name: Optional[str] = None,
                   project_id: Optional[str] = None,
                   stream_config: Optional[StreamInstanceStreamConfigArgs] = None)
    func NewStreamInstance(ctx *Context, name string, args StreamInstanceArgs, opts ...ResourceOption) (*StreamInstance, error)
    public StreamInstance(string name, StreamInstanceArgs args, CustomResourceOptions? opts = null)
    public StreamInstance(String name, StreamInstanceArgs args)
public StreamInstance(String name, StreamInstanceArgs args, CustomResourceOptions options)

    type: mongodbatlas:StreamInstance
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 StreamInstanceArgs
    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 StreamInstanceArgs
    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 StreamInstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StreamInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StreamInstanceArgs
    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 streamInstanceResource = new Mongodbatlas.StreamInstance("streamInstanceResource", new()
{
    DataProcessRegion = new Mongodbatlas.Inputs.StreamInstanceDataProcessRegionArgs
    {
        CloudProvider = "string",
        Region = "string",
    },
    InstanceName = "string",
    ProjectId = "string",
    StreamConfig = new Mongodbatlas.Inputs.StreamInstanceStreamConfigArgs
    {
        Tier = "string",
    },
});

    example, err := mongodbatlas.NewStreamInstance(ctx, "streamInstanceResource", &mongodbatlas.StreamInstanceArgs{
	DataProcessRegion: &mongodbatlas.StreamInstanceDataProcessRegionArgs{
		CloudProvider: pulumi.String("string"),
		Region:        pulumi.String("string"),
	},
	InstanceName: pulumi.String("string"),
	ProjectId:    pulumi.String("string"),
	StreamConfig: &mongodbatlas.StreamInstanceStreamConfigArgs{
		Tier: pulumi.String("string"),
	},
})

    var streamInstanceResource = new StreamInstance("streamInstanceResource", StreamInstanceArgs.builder()
    .dataProcessRegion(StreamInstanceDataProcessRegionArgs.builder()
        .cloudProvider("string")
        .region("string")
        .build())
    .instanceName("string")
    .projectId("string")
    .streamConfig(StreamInstanceStreamConfigArgs.builder()
        .tier("string")
        .build())
    .build());

    stream_instance_resource = mongodbatlas.StreamInstance("streamInstanceResource",
    data_process_region=mongodbatlas.StreamInstanceDataProcessRegionArgs(
        cloud_provider="string",
        region="string",
    ),
    instance_name="string",
    project_id="string",
    stream_config=mongodbatlas.StreamInstanceStreamConfigArgs(
        tier="string",
    ))

    const streamInstanceResource = new mongodbatlas.StreamInstance("streamInstanceResource", {
    dataProcessRegion: {
        cloudProvider: "string",
        region: "string",
    },
    instanceName: "string",
    projectId: "string",
    streamConfig: {
        tier: "string",
    },
});

    type: mongodbatlas:StreamInstance
properties:
    dataProcessRegion:
        cloudProvider: string
        region: string
    instanceName: string
    projectId: string
    streamConfig:
        tier: string

    StreamInstance 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 StreamInstance resource accepts the following input properties:

    DataProcessRegion StreamInstanceDataProcessRegion
    Cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
    InstanceName string
    Human-readable label that identifies the stream instance.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project.
    StreamConfig StreamInstanceStreamConfig
    Configuration options for an Atlas Stream Processing Instance. See stream config
    DataProcessRegion StreamInstanceDataProcessRegionArgs
    Cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
    InstanceName string
    Human-readable label that identifies the stream instance.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project.
    StreamConfig StreamInstanceStreamConfigArgs
    Configuration options for an Atlas Stream Processing Instance. See stream config
    dataProcessRegion StreamInstanceDataProcessRegion
    Cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
    instanceName String
    Human-readable label that identifies the stream instance.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project.
    streamConfig StreamInstanceStreamConfig
    Configuration options for an Atlas Stream Processing Instance. See stream config
    dataProcessRegion StreamInstanceDataProcessRegion
    Cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
    instanceName string
    Human-readable label that identifies the stream instance.
    projectId string
    Unique 24-hexadecimal digit string that identifies your project.
    streamConfig StreamInstanceStreamConfig
    Configuration options for an Atlas Stream Processing Instance. See stream config
    data_process_region StreamInstanceDataProcessRegionArgs
    Cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
    instance_name str
    Human-readable label that identifies the stream instance.
    project_id str
    Unique 24-hexadecimal digit string that identifies your project.
    stream_config StreamInstanceStreamConfigArgs
    Configuration options for an Atlas Stream Processing Instance. See stream config
    dataProcessRegion Property Map
    Cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
    instanceName String
    Human-readable label that identifies the stream instance.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project.
    streamConfig Property Map
    Configuration options for an Atlas Stream Processing Instance. See stream config

    Outputs

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

    Hostnames List<string>
    List that contains the hostnames assigned to the stream instance.
    Id string
    The provider-assigned unique ID for this managed resource.
    Hostnames []string
    List that contains the hostnames assigned to the stream instance.
    Id string
    The provider-assigned unique ID for this managed resource.
    hostnames List<String>
    List that contains the hostnames assigned to the stream instance.
    id String
    The provider-assigned unique ID for this managed resource.
    hostnames string[]
    List that contains the hostnames assigned to the stream instance.
    id string
    The provider-assigned unique ID for this managed resource.
    hostnames Sequence[str]
    List that contains the hostnames assigned to the stream instance.
    id str
    The provider-assigned unique ID for this managed resource.
    hostnames List<String>
    List that contains the hostnames assigned to the stream instance.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing StreamInstance Resource

    Get an existing StreamInstance 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?: StreamInstanceState, opts?: CustomResourceOptions): StreamInstance
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        data_process_region: Optional[StreamInstanceDataProcessRegionArgs] = None,
        hostnames: Optional[Sequence[str]] = None,
        instance_name: Optional[str] = None,
        project_id: Optional[str] = None,
        stream_config: Optional[StreamInstanceStreamConfigArgs] = None) -> StreamInstance
    func GetStreamInstance(ctx *Context, name string, id IDInput, state *StreamInstanceState, opts ...ResourceOption) (*StreamInstance, error)
    public static StreamInstance Get(string name, Input<string> id, StreamInstanceState? state, CustomResourceOptions? opts = null)
    public static StreamInstance get(String name, Output<String> id, StreamInstanceState 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:
    DataProcessRegion StreamInstanceDataProcessRegion
    Cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
    Hostnames List<string>
    List that contains the hostnames assigned to the stream instance.
    InstanceName string
    Human-readable label that identifies the stream instance.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project.
    StreamConfig StreamInstanceStreamConfig
    Configuration options for an Atlas Stream Processing Instance. See stream config
    DataProcessRegion StreamInstanceDataProcessRegionArgs
    Cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
    Hostnames []string
    List that contains the hostnames assigned to the stream instance.
    InstanceName string
    Human-readable label that identifies the stream instance.
    ProjectId string
    Unique 24-hexadecimal digit string that identifies your project.
    StreamConfig StreamInstanceStreamConfigArgs
    Configuration options for an Atlas Stream Processing Instance. See stream config
    dataProcessRegion StreamInstanceDataProcessRegion
    Cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
    hostnames List<String>
    List that contains the hostnames assigned to the stream instance.
    instanceName String
    Human-readable label that identifies the stream instance.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project.
    streamConfig StreamInstanceStreamConfig
    Configuration options for an Atlas Stream Processing Instance. See stream config
    dataProcessRegion StreamInstanceDataProcessRegion
    Cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
    hostnames string[]
    List that contains the hostnames assigned to the stream instance.
    instanceName string
    Human-readable label that identifies the stream instance.
    projectId string
    Unique 24-hexadecimal digit string that identifies your project.
    streamConfig StreamInstanceStreamConfig
    Configuration options for an Atlas Stream Processing Instance. See stream config
    data_process_region StreamInstanceDataProcessRegionArgs
    Cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
    hostnames Sequence[str]
    List that contains the hostnames assigned to the stream instance.
    instance_name str
    Human-readable label that identifies the stream instance.
    project_id str
    Unique 24-hexadecimal digit string that identifies your project.
    stream_config StreamInstanceStreamConfigArgs
    Configuration options for an Atlas Stream Processing Instance. See stream config
    dataProcessRegion Property Map
    Cloud service provider and region where MongoDB Cloud performs stream processing. See data process region.
    hostnames List<String>
    List that contains the hostnames assigned to the stream instance.
    instanceName String
    Human-readable label that identifies the stream instance.
    projectId String
    Unique 24-hexadecimal digit string that identifies your project.
    streamConfig Property Map
    Configuration options for an Atlas Stream Processing Instance. See stream config

    Supporting Types

    StreamInstanceDataProcessRegion, StreamInstanceDataProcessRegionArgs

    CloudProvider string
    Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. The MongoDB Atlas API describes the valid values.
    Region string
    Name of the cloud provider region hosting Atlas Stream Processing. The MongoDB Atlas API describes the valid values.
    CloudProvider string
    Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. The MongoDB Atlas API describes the valid values.
    Region string
    Name of the cloud provider region hosting Atlas Stream Processing. The MongoDB Atlas API describes the valid values.
    cloudProvider String
    Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. The MongoDB Atlas API describes the valid values.
    region String
    Name of the cloud provider region hosting Atlas Stream Processing. The MongoDB Atlas API describes the valid values.
    cloudProvider string
    Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. The MongoDB Atlas API describes the valid values.
    region string
    Name of the cloud provider region hosting Atlas Stream Processing. The MongoDB Atlas API describes the valid values.
    cloud_provider str
    Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. The MongoDB Atlas API describes the valid values.
    region str
    Name of the cloud provider region hosting Atlas Stream Processing. The MongoDB Atlas API describes the valid values.
    cloudProvider String
    Label that identifies the cloud service provider where MongoDB Cloud performs stream processing. The MongoDB Atlas API describes the valid values.
    region String
    Name of the cloud provider region hosting Atlas Stream Processing. The MongoDB Atlas API describes the valid values.

    StreamInstanceStreamConfig, StreamInstanceStreamConfigArgs

    Tier string
    Selected tier for the Stream Instance. Configures Memory / VCPU allowances. The MongoDB Atlas API describes the valid values.
    Tier string
    Selected tier for the Stream Instance. Configures Memory / VCPU allowances. The MongoDB Atlas API describes the valid values.
    tier String
    Selected tier for the Stream Instance. Configures Memory / VCPU allowances. The MongoDB Atlas API describes the valid values.
    tier string
    Selected tier for the Stream Instance. Configures Memory / VCPU allowances. The MongoDB Atlas API describes the valid values.
    tier str
    Selected tier for the Stream Instance. Configures Memory / VCPU allowances. The MongoDB Atlas API describes the valid values.
    tier String
    Selected tier for the Stream Instance. Configures Memory / VCPU allowances. The MongoDB Atlas API describes the valid values.

    Import

    You can import stream instance resource using the project ID and instance name, in the format PROJECT_ID-INSTANCE_NAME. For example:

    $ pulumi import mongodbatlas:index/streamInstance:StreamInstance test 650972848269185c55f40ca1-InstanceName

    To learn more, see: MongoDB Atlas API - Stream Instance Documentation. The Terraform Provider Examples Section also contains details on the overall support for Atlas Streams Processing in Terraform.

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

    Package Details

    Repository
    MongoDB Atlas pulumi/pulumi-mongodbatlas
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mongodbatlas Terraform Provider.
    mongodbatlas logo
    MongoDB Atlas v3.18.0 published on Thursday, Sep 12, 2024 by Pulumi
    pulumi/pulumi-mongodbatlas