Scaleway v1.20.0 published on Monday, Nov 4, 2024 by pulumiverse
scaleway.getRedisCluster
Explore with Pulumi AI
Gets information about a Redis™ cluster.
For further information refer to the Managed Database for Redis™ API documentation.
Using getRedisCluster
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 getRedisCluster(args: GetRedisClusterArgs, opts?: InvokeOptions): Promise<GetRedisClusterResult>
function getRedisClusterOutput(args: GetRedisClusterOutputArgs, opts?: InvokeOptions): Output<GetRedisClusterResult>
def get_redis_cluster(cluster_id: Optional[str] = None,
name: Optional[str] = None,
project_id: Optional[str] = None,
zone: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetRedisClusterResult
def get_redis_cluster_output(cluster_id: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
project_id: Optional[pulumi.Input[str]] = None,
zone: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetRedisClusterResult]
func LookupRedisCluster(ctx *Context, args *LookupRedisClusterArgs, opts ...InvokeOption) (*LookupRedisClusterResult, error)
func LookupRedisClusterOutput(ctx *Context, args *LookupRedisClusterOutputArgs, opts ...InvokeOption) LookupRedisClusterResultOutput
> Note: This function is named LookupRedisCluster
in the Go SDK.
public static class GetRedisCluster
{
public static Task<GetRedisClusterResult> InvokeAsync(GetRedisClusterArgs args, InvokeOptions? opts = null)
public static Output<GetRedisClusterResult> Invoke(GetRedisClusterInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetRedisClusterResult> getRedisCluster(GetRedisClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: scaleway:index/getRedisCluster:getRedisCluster
arguments:
# arguments dictionary
The following arguments are supported:
- cluster_
id str The Redis cluster ID.
Note You must specify at least one:
name
and/orcluster_id
.- name str
- The name of the Redis cluster.
- project_
id str - The ID of the project the Redis cluster is associated with.
- zone str
region
) The zone in which the server exists.
getRedisCluster Result
The following output properties are available:
- Acls
List<Pulumiverse.
Scaleway. Outputs. Get Redis Cluster Acl> - List of acl rules.
- Certificate string
- The PEM of the certificate used by redis, only when
tls_enabled
is true. - Cluster
Size int - The number of nodes in the Redis Cluster.
- Created
At string - The date and time of creation of the Redis Cluster.
- Id string
- The provider-assigned unique ID for this managed resource.
- Node
Type string - The type of Redis Cluster (e.g.
RED1-M
). - Password string
- Password of the first user of the Redis Cluster.
- Private
Networks List<Pulumiverse.Scaleway. Outputs. Get Redis Cluster Private Network> - List of private networks endpoints of the Redis Cluster.
- Public
Networks List<Pulumiverse.Scaleway. Outputs. Get Redis Cluster Public Network> - Public network details.
- Settings Dictionary<string, string>
- Map of settings for redis cluster.
- List<string>
- The tags associated with the Redis Cluster.
- Tls
Enabled bool - Whether TLS is enabled or not.
- Updated
At string - The date and time of the last update of the Redis Cluster.
- User
Name string - The first user of the Redis Cluster.
- Version string
- Redis's Cluster version (e.g.
6.2.7
). - Cluster
Id string - Name string
- Project
Id string - Zone string
- Acls
[]Get
Redis Cluster Acl - List of acl rules.
- Certificate string
- The PEM of the certificate used by redis, only when
tls_enabled
is true. - Cluster
Size int - The number of nodes in the Redis Cluster.
- Created
At string - The date and time of creation of the Redis Cluster.
- Id string
- The provider-assigned unique ID for this managed resource.
- Node
Type string - The type of Redis Cluster (e.g.
RED1-M
). - Password string
- Password of the first user of the Redis Cluster.
- Private
Networks []GetRedis Cluster Private Network - List of private networks endpoints of the Redis Cluster.
- Public
Networks []GetRedis Cluster Public Network - Public network details.
- Settings map[string]string
- Map of settings for redis cluster.
- []string
- The tags associated with the Redis Cluster.
- Tls
Enabled bool - Whether TLS is enabled or not.
- Updated
At string - The date and time of the last update of the Redis Cluster.
- User
Name string - The first user of the Redis Cluster.
- Version string
- Redis's Cluster version (e.g.
6.2.7
). - Cluster
Id string - Name string
- Project
Id string - Zone string
- acls
List<Get
Redis Cluster Acl> - List of acl rules.
- certificate String
- The PEM of the certificate used by redis, only when
tls_enabled
is true. - cluster
Size Integer - The number of nodes in the Redis Cluster.
- created
At String - The date and time of creation of the Redis Cluster.
- id String
- The provider-assigned unique ID for this managed resource.
- node
Type String - The type of Redis Cluster (e.g.
RED1-M
). - password String
- Password of the first user of the Redis Cluster.
- private
Networks List<GetRedis Cluster Private Network> - List of private networks endpoints of the Redis Cluster.
- public
Networks List<GetRedis Cluster Public Network> - Public network details.
- settings Map<String,String>
- Map of settings for redis cluster.
- List<String>
- The tags associated with the Redis Cluster.
- tls
Enabled Boolean - Whether TLS is enabled or not.
- updated
At String - The date and time of the last update of the Redis Cluster.
- user
Name String - The first user of the Redis Cluster.
- version String
- Redis's Cluster version (e.g.
6.2.7
). - cluster
Id String - name String
- project
Id String - zone String
- acls
Get
Redis Cluster Acl[] - List of acl rules.
- certificate string
- The PEM of the certificate used by redis, only when
tls_enabled
is true. - cluster
Size number - The number of nodes in the Redis Cluster.
- created
At string - The date and time of creation of the Redis Cluster.
- id string
- The provider-assigned unique ID for this managed resource.
- node
Type string - The type of Redis Cluster (e.g.
RED1-M
). - password string
- Password of the first user of the Redis Cluster.
- private
Networks GetRedis Cluster Private Network[] - List of private networks endpoints of the Redis Cluster.
- public
Networks GetRedis Cluster Public Network[] - Public network details.
- settings {[key: string]: string}
- Map of settings for redis cluster.
- string[]
- The tags associated with the Redis Cluster.
- tls
Enabled boolean - Whether TLS is enabled or not.
- updated
At string - The date and time of the last update of the Redis Cluster.
- user
Name string - The first user of the Redis Cluster.
- version string
- Redis's Cluster version (e.g.
6.2.7
). - cluster
Id string - name string
- project
Id string - zone string
- acls
Sequence[Get
Redis Cluster Acl] - List of acl rules.
- certificate str
- The PEM of the certificate used by redis, only when
tls_enabled
is true. - cluster_
size int - The number of nodes in the Redis Cluster.
- created_
at str - The date and time of creation of the Redis Cluster.
- id str
- The provider-assigned unique ID for this managed resource.
- node_
type str - The type of Redis Cluster (e.g.
RED1-M
). - password str
- Password of the first user of the Redis Cluster.
- private_
networks Sequence[GetRedis Cluster Private Network] - List of private networks endpoints of the Redis Cluster.
- public_
networks Sequence[GetRedis Cluster Public Network] - Public network details.
- settings Mapping[str, str]
- Map of settings for redis cluster.
- Sequence[str]
- The tags associated with the Redis Cluster.
- tls_
enabled bool - Whether TLS is enabled or not.
- updated_
at str - The date and time of the last update of the Redis Cluster.
- user_
name str - The first user of the Redis Cluster.
- version str
- Redis's Cluster version (e.g.
6.2.7
). - cluster_
id str - name str
- project_
id str - zone str
- acls List<Property Map>
- List of acl rules.
- certificate String
- The PEM of the certificate used by redis, only when
tls_enabled
is true. - cluster
Size Number - The number of nodes in the Redis Cluster.
- created
At String - The date and time of creation of the Redis Cluster.
- id String
- The provider-assigned unique ID for this managed resource.
- node
Type String - The type of Redis Cluster (e.g.
RED1-M
). - password String
- Password of the first user of the Redis Cluster.
- private
Networks List<Property Map> - List of private networks endpoints of the Redis Cluster.
- public
Networks List<Property Map> - Public network details.
- settings Map<String>
- Map of settings for redis cluster.
- List<String>
- The tags associated with the Redis Cluster.
- tls
Enabled Boolean - Whether TLS is enabled or not.
- updated
At String - The date and time of the last update of the Redis Cluster.
- user
Name String - The first user of the Redis Cluster.
- version String
- Redis's Cluster version (e.g.
6.2.7
). - cluster
Id String - name String
- project
Id String - zone String
Supporting Types
GetRedisClusterAcl
- Description string
- Description of the rule.
- Id string
- The ID of the Redis cluster.
- Ip string
- IPv4 network address of the rule (IP network in a CIDR format).
- Description string
- Description of the rule.
- Id string
- The ID of the Redis cluster.
- Ip string
- IPv4 network address of the rule (IP network in a CIDR format).
- description String
- Description of the rule.
- id String
- The ID of the Redis cluster.
- ip String
- IPv4 network address of the rule (IP network in a CIDR format).
- description string
- Description of the rule.
- id string
- The ID of the Redis cluster.
- ip string
- IPv4 network address of the rule (IP network in a CIDR format).
- description str
- Description of the rule.
- id str
- The ID of the Redis cluster.
- ip str
- IPv4 network address of the rule (IP network in a CIDR format).
- description String
- Description of the rule.
- id String
- The ID of the Redis cluster.
- ip String
- IPv4 network address of the rule (IP network in a CIDR format).
GetRedisClusterPrivateNetwork
- Endpoint
Id string - The ID of the endpoint.
- Id string
- The ID of the Redis cluster.
- Service
Ips List<string> - List of IPv4 addresses of the private network with a CIDR notation
- Zone string
region
) The zone in which the server exists.
- Endpoint
Id string - The ID of the endpoint.
- Id string
- The ID of the Redis cluster.
- Service
Ips []string - List of IPv4 addresses of the private network with a CIDR notation
- Zone string
region
) The zone in which the server exists.
- endpoint
Id String - The ID of the endpoint.
- id String
- The ID of the Redis cluster.
- service
Ips List<String> - List of IPv4 addresses of the private network with a CIDR notation
- zone String
region
) The zone in which the server exists.
- endpoint
Id string - The ID of the endpoint.
- id string
- The ID of the Redis cluster.
- service
Ips string[] - List of IPv4 addresses of the private network with a CIDR notation
- zone string
region
) The zone in which the server exists.
- endpoint_
id str - The ID of the endpoint.
- id str
- The ID of the Redis cluster.
- service_
ips Sequence[str] - List of IPv4 addresses of the private network with a CIDR notation
- zone str
region
) The zone in which the server exists.
- endpoint
Id String - The ID of the endpoint.
- id String
- The ID of the Redis cluster.
- service
Ips List<String> - List of IPv4 addresses of the private network with a CIDR notation
- zone String
region
) The zone in which the server exists.
GetRedisClusterPublicNetwork
Package Details
- Repository
- scaleway pulumiverse/pulumi-scaleway
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
scaleway
Terraform Provider.