1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. elasticache
  5. getGlobalReplicationGroup

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

aws-native.elasticache.getGlobalReplicationGroup

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

    The AWS::ElastiCache::GlobalReplicationGroup resource creates an Amazon ElastiCache Global Replication Group.

    Using getGlobalReplicationGroup

    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 getGlobalReplicationGroup(args: GetGlobalReplicationGroupArgs, opts?: InvokeOptions): Promise<GetGlobalReplicationGroupResult>
    function getGlobalReplicationGroupOutput(args: GetGlobalReplicationGroupOutputArgs, opts?: InvokeOptions): Output<GetGlobalReplicationGroupResult>
    def get_global_replication_group(global_replication_group_id: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetGlobalReplicationGroupResult
    def get_global_replication_group_output(global_replication_group_id: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetGlobalReplicationGroupResult]
    func LookupGlobalReplicationGroup(ctx *Context, args *LookupGlobalReplicationGroupArgs, opts ...InvokeOption) (*LookupGlobalReplicationGroupResult, error)
    func LookupGlobalReplicationGroupOutput(ctx *Context, args *LookupGlobalReplicationGroupOutputArgs, opts ...InvokeOption) LookupGlobalReplicationGroupResultOutput

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

    public static class GetGlobalReplicationGroup 
    {
        public static Task<GetGlobalReplicationGroupResult> InvokeAsync(GetGlobalReplicationGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetGlobalReplicationGroupResult> Invoke(GetGlobalReplicationGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetGlobalReplicationGroupResult> getGlobalReplicationGroup(GetGlobalReplicationGroupArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:elasticache:getGlobalReplicationGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    GlobalReplicationGroupId string
    The name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix.
    GlobalReplicationGroupId string
    The name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix.
    globalReplicationGroupId String
    The name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix.
    globalReplicationGroupId string
    The name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix.
    global_replication_group_id str
    The name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix.
    globalReplicationGroupId String
    The name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix.

    getGlobalReplicationGroup Result

    The following output properties are available:

    CacheParameterGroupName string
    Cache parameter group name to use for the new engine version. This parameter cannot be modified independently.
    GlobalReplicationGroupDescription string
    The optional description of the Global Datastore
    GlobalReplicationGroupId string
    The name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix.
    Members List<Pulumi.AwsNative.ElastiCache.Outputs.GlobalReplicationGroupMember>
    The replication groups that comprise the Global Datastore.
    Status string
    The status of the Global Datastore
    CacheParameterGroupName string
    Cache parameter group name to use for the new engine version. This parameter cannot be modified independently.
    GlobalReplicationGroupDescription string
    The optional description of the Global Datastore
    GlobalReplicationGroupId string
    The name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix.
    Members []GlobalReplicationGroupMember
    The replication groups that comprise the Global Datastore.
    Status string
    The status of the Global Datastore
    cacheParameterGroupName String
    Cache parameter group name to use for the new engine version. This parameter cannot be modified independently.
    globalReplicationGroupDescription String
    The optional description of the Global Datastore
    globalReplicationGroupId String
    The name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix.
    members List<GlobalReplicationGroupMember>
    The replication groups that comprise the Global Datastore.
    status String
    The status of the Global Datastore
    cacheParameterGroupName string
    Cache parameter group name to use for the new engine version. This parameter cannot be modified independently.
    globalReplicationGroupDescription string
    The optional description of the Global Datastore
    globalReplicationGroupId string
    The name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix.
    members GlobalReplicationGroupMember[]
    The replication groups that comprise the Global Datastore.
    status string
    The status of the Global Datastore
    cache_parameter_group_name str
    Cache parameter group name to use for the new engine version. This parameter cannot be modified independently.
    global_replication_group_description str
    The optional description of the Global Datastore
    global_replication_group_id str
    The name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix.
    members Sequence[GlobalReplicationGroupMember]
    The replication groups that comprise the Global Datastore.
    status str
    The status of the Global Datastore
    cacheParameterGroupName String
    Cache parameter group name to use for the new engine version. This parameter cannot be modified independently.
    globalReplicationGroupDescription String
    The optional description of the Global Datastore
    globalReplicationGroupId String
    The name of the Global Datastore, it is generated by ElastiCache adding a prefix to GlobalReplicationGroupIdSuffix.
    members List<Property Map>
    The replication groups that comprise the Global Datastore.
    status String
    The status of the Global Datastore

    Supporting Types

    GlobalReplicationGroupMember

    ReplicationGroupId string
    Regionally unique identifier for the member i.e. ReplicationGroupId.
    ReplicationGroupRegion string
    The AWS region of the Global Datastore member.
    Role Pulumi.AwsNative.ElastiCache.GlobalReplicationGroupMemberRole
    Indicates the role of the member, primary or secondary.
    ReplicationGroupId string
    Regionally unique identifier for the member i.e. ReplicationGroupId.
    ReplicationGroupRegion string
    The AWS region of the Global Datastore member.
    Role GlobalReplicationGroupMemberRole
    Indicates the role of the member, primary or secondary.
    replicationGroupId String
    Regionally unique identifier for the member i.e. ReplicationGroupId.
    replicationGroupRegion String
    The AWS region of the Global Datastore member.
    role GlobalReplicationGroupMemberRole
    Indicates the role of the member, primary or secondary.
    replicationGroupId string
    Regionally unique identifier for the member i.e. ReplicationGroupId.
    replicationGroupRegion string
    The AWS region of the Global Datastore member.
    role GlobalReplicationGroupMemberRole
    Indicates the role of the member, primary or secondary.
    replication_group_id str
    Regionally unique identifier for the member i.e. ReplicationGroupId.
    replication_group_region str
    The AWS region of the Global Datastore member.
    role GlobalReplicationGroupMemberRole
    Indicates the role of the member, primary or secondary.
    replicationGroupId String
    Regionally unique identifier for the member i.e. ReplicationGroupId.
    replicationGroupRegion String
    The AWS region of the Global Datastore member.
    role "PRIMARY" | "SECONDARY"
    Indicates the role of the member, primary or secondary.

    GlobalReplicationGroupMemberRole

    Package Details

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

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi