1. Packages
  2. CockroachDB Cloud
  3. API Docs
  4. AllowList
CockroachDB v0.2.2 published on Monday, Mar 11, 2024 by pulumiverse

cockroach.AllowList

Explore with Pulumi AI

cockroach logo
CockroachDB v0.2.2 published on Monday, Mar 11, 2024 by pulumiverse

    List of IP ranges allowed to access the cluster.

    Create AllowList Resource

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

    Constructor syntax

    new AllowList(name: string, args: AllowListArgs, opts?: CustomResourceOptions);
    @overload
    def AllowList(resource_name: str,
                  args: AllowListArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def AllowList(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  cidr_ip: Optional[str] = None,
                  cidr_mask: Optional[int] = None,
                  cluster_id: Optional[str] = None,
                  sql: Optional[bool] = None,
                  ui: Optional[bool] = None,
                  name: Optional[str] = None)
    func NewAllowList(ctx *Context, name string, args AllowListArgs, opts ...ResourceOption) (*AllowList, error)
    public AllowList(string name, AllowListArgs args, CustomResourceOptions? opts = null)
    public AllowList(String name, AllowListArgs args)
    public AllowList(String name, AllowListArgs args, CustomResourceOptions options)
    
    type: cockroach:AllowList
    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 AllowListArgs
    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 AllowListArgs
    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 AllowListArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AllowListArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AllowListArgs
    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 allowListResource = new Cockroach.AllowList("allowListResource", new()
    {
        CidrIp = "string",
        CidrMask = 0,
        ClusterId = "string",
        Sql = false,
        Ui = false,
        Name = "string",
    });
    
    example, err := cockroach.NewAllowList(ctx, "allowListResource", &cockroach.AllowListArgs{
    	CidrIp:    pulumi.String("string"),
    	CidrMask:  pulumi.Int(0),
    	ClusterId: pulumi.String("string"),
    	Sql:       pulumi.Bool(false),
    	Ui:        pulumi.Bool(false),
    	Name:      pulumi.String("string"),
    })
    
    var allowListResource = new AllowList("allowListResource", AllowListArgs.builder()        
        .cidrIp("string")
        .cidrMask(0)
        .clusterId("string")
        .sql(false)
        .ui(false)
        .name("string")
        .build());
    
    allow_list_resource = cockroach.AllowList("allowListResource",
        cidr_ip="string",
        cidr_mask=0,
        cluster_id="string",
        sql=False,
        ui=False,
        name="string")
    
    const allowListResource = new cockroach.AllowList("allowListResource", {
        cidrIp: "string",
        cidrMask: 0,
        clusterId: "string",
        sql: false,
        ui: false,
        name: "string",
    });
    
    type: cockroach:AllowList
    properties:
        cidrIp: string
        cidrMask: 0
        clusterId: string
        name: string
        sql: false
        ui: false
    

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

    CidrIp string
    IP address component of the CIDR range for this entry.
    CidrMask int
    Map component of the CIDR range for this entry.
    ClusterId string
    Sql bool
    Set to 'true' to allow SQL connections from this CIDR range.
    Ui bool
    Set to 'true' to allow access to the management console from this CIDR range.
    Name string
    Name of this allowlist entry.
    CidrIp string
    IP address component of the CIDR range for this entry.
    CidrMask int
    Map component of the CIDR range for this entry.
    ClusterId string
    Sql bool
    Set to 'true' to allow SQL connections from this CIDR range.
    Ui bool
    Set to 'true' to allow access to the management console from this CIDR range.
    Name string
    Name of this allowlist entry.
    cidrIp String
    IP address component of the CIDR range for this entry.
    cidrMask Integer
    Map component of the CIDR range for this entry.
    clusterId String
    sql Boolean
    Set to 'true' to allow SQL connections from this CIDR range.
    ui Boolean
    Set to 'true' to allow access to the management console from this CIDR range.
    name String
    Name of this allowlist entry.
    cidrIp string
    IP address component of the CIDR range for this entry.
    cidrMask number
    Map component of the CIDR range for this entry.
    clusterId string
    sql boolean
    Set to 'true' to allow SQL connections from this CIDR range.
    ui boolean
    Set to 'true' to allow access to the management console from this CIDR range.
    name string
    Name of this allowlist entry.
    cidr_ip str
    IP address component of the CIDR range for this entry.
    cidr_mask int
    Map component of the CIDR range for this entry.
    cluster_id str
    sql bool
    Set to 'true' to allow SQL connections from this CIDR range.
    ui bool
    Set to 'true' to allow access to the management console from this CIDR range.
    name str
    Name of this allowlist entry.
    cidrIp String
    IP address component of the CIDR range for this entry.
    cidrMask Number
    Map component of the CIDR range for this entry.
    clusterId String
    sql Boolean
    Set to 'true' to allow SQL connections from this CIDR range.
    ui Boolean
    Set to 'true' to allow access to the management console from this CIDR range.
    name String
    Name of this allowlist entry.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AllowList Resource

    Get an existing AllowList 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?: AllowListState, opts?: CustomResourceOptions): AllowList
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            cidr_ip: Optional[str] = None,
            cidr_mask: Optional[int] = None,
            cluster_id: Optional[str] = None,
            name: Optional[str] = None,
            sql: Optional[bool] = None,
            ui: Optional[bool] = None) -> AllowList
    func GetAllowList(ctx *Context, name string, id IDInput, state *AllowListState, opts ...ResourceOption) (*AllowList, error)
    public static AllowList Get(string name, Input<string> id, AllowListState? state, CustomResourceOptions? opts = null)
    public static AllowList get(String name, Output<String> id, AllowListState 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:
    CidrIp string
    IP address component of the CIDR range for this entry.
    CidrMask int
    Map component of the CIDR range for this entry.
    ClusterId string
    Name string
    Name of this allowlist entry.
    Sql bool
    Set to 'true' to allow SQL connections from this CIDR range.
    Ui bool
    Set to 'true' to allow access to the management console from this CIDR range.
    CidrIp string
    IP address component of the CIDR range for this entry.
    CidrMask int
    Map component of the CIDR range for this entry.
    ClusterId string
    Name string
    Name of this allowlist entry.
    Sql bool
    Set to 'true' to allow SQL connections from this CIDR range.
    Ui bool
    Set to 'true' to allow access to the management console from this CIDR range.
    cidrIp String
    IP address component of the CIDR range for this entry.
    cidrMask Integer
    Map component of the CIDR range for this entry.
    clusterId String
    name String
    Name of this allowlist entry.
    sql Boolean
    Set to 'true' to allow SQL connections from this CIDR range.
    ui Boolean
    Set to 'true' to allow access to the management console from this CIDR range.
    cidrIp string
    IP address component of the CIDR range for this entry.
    cidrMask number
    Map component of the CIDR range for this entry.
    clusterId string
    name string
    Name of this allowlist entry.
    sql boolean
    Set to 'true' to allow SQL connections from this CIDR range.
    ui boolean
    Set to 'true' to allow access to the management console from this CIDR range.
    cidr_ip str
    IP address component of the CIDR range for this entry.
    cidr_mask int
    Map component of the CIDR range for this entry.
    cluster_id str
    name str
    Name of this allowlist entry.
    sql bool
    Set to 'true' to allow SQL connections from this CIDR range.
    ui bool
    Set to 'true' to allow access to the management console from this CIDR range.
    cidrIp String
    IP address component of the CIDR range for this entry.
    cidrMask Number
    Map component of the CIDR range for this entry.
    clusterId String
    name String
    Name of this allowlist entry.
    sql Boolean
    Set to 'true' to allow SQL connections from this CIDR range.
    ui Boolean
    Set to 'true' to allow access to the management console from this CIDR range.

    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.2 published on Monday, Mar 11, 2024 by pulumiverse