libZSservicesZSamazonka-redshiftZSamazonka-redshift
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Redshift.AssociateDataShareConsumer

Description

From a datashare consumer account, associates a datashare with the account (AssociateEntireAccount) or the specified namespace (ConsumerArn). If you make this association, the consumer can consume the datashare.

Synopsis

Creating a Request

data AssociateDataShareConsumer Source #

See: newAssociateDataShareConsumer smart constructor.

Constructors

AssociateDataShareConsumer' 

Fields

  • associateEntireAccount :: Maybe Bool

    A value that specifies whether the datashare is associated with the entire account.

  • consumerArn :: Maybe Text

    The Amazon Resource Name (ARN) of the consumer that is associated with the datashare.

  • dataShareArn :: Text

    The Amazon Resource Name (ARN) of the datashare that the consumer is to use with the account or the namespace.

Instances

Instances details
Eq AssociateDataShareConsumer Source # 
Instance details

Defined in Amazonka.Redshift.AssociateDataShareConsumer

Read AssociateDataShareConsumer Source # 
Instance details

Defined in Amazonka.Redshift.AssociateDataShareConsumer

Show AssociateDataShareConsumer Source # 
Instance details

Defined in Amazonka.Redshift.AssociateDataShareConsumer

Generic AssociateDataShareConsumer Source # 
Instance details

Defined in Amazonka.Redshift.AssociateDataShareConsumer

Associated Types

type Rep AssociateDataShareConsumer :: Type -> Type #

NFData AssociateDataShareConsumer Source # 
Instance details

Defined in Amazonka.Redshift.AssociateDataShareConsumer

Hashable AssociateDataShareConsumer Source # 
Instance details

Defined in Amazonka.Redshift.AssociateDataShareConsumer

AWSRequest AssociateDataShareConsumer Source # 
Instance details

Defined in Amazonka.Redshift.AssociateDataShareConsumer

ToHeaders AssociateDataShareConsumer Source # 
Instance details

Defined in Amazonka.Redshift.AssociateDataShareConsumer

ToPath AssociateDataShareConsumer Source # 
Instance details

Defined in Amazonka.Redshift.AssociateDataShareConsumer

ToQuery AssociateDataShareConsumer Source # 
Instance details

Defined in Amazonka.Redshift.AssociateDataShareConsumer

type Rep AssociateDataShareConsumer Source # 
Instance details

Defined in Amazonka.Redshift.AssociateDataShareConsumer

type Rep AssociateDataShareConsumer = D1 ('MetaData "AssociateDataShareConsumer" "Amazonka.Redshift.AssociateDataShareConsumer" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "AssociateDataShareConsumer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "associateEntireAccount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "consumerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dataShareArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse AssociateDataShareConsumer Source # 
Instance details

Defined in Amazonka.Redshift.AssociateDataShareConsumer

newAssociateDataShareConsumer Source #

Create a value of AssociateDataShareConsumer with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:associateEntireAccount:AssociateDataShareConsumer', associateDataShareConsumer_associateEntireAccount - A value that specifies whether the datashare is associated with the entire account.

$sel:consumerArn:AssociateDataShareConsumer', associateDataShareConsumer_consumerArn - The Amazon Resource Name (ARN) of the consumer that is associated with the datashare.

$sel:dataShareArn:AssociateDataShareConsumer', associateDataShareConsumer_dataShareArn - The Amazon Resource Name (ARN) of the datashare that the consumer is to use with the account or the namespace.

Request Lenses

associateDataShareConsumer_associateEntireAccount :: Lens' AssociateDataShareConsumer (Maybe Bool) Source #

A value that specifies whether the datashare is associated with the entire account.

associateDataShareConsumer_consumerArn :: Lens' AssociateDataShareConsumer (Maybe Text) Source #

The Amazon Resource Name (ARN) of the consumer that is associated with the datashare.

associateDataShareConsumer_dataShareArn :: Lens' AssociateDataShareConsumer Text Source #

The Amazon Resource Name (ARN) of the datashare that the consumer is to use with the account or the namespace.

Destructuring the Response

data DataShare Source #

See: newDataShare smart constructor.

Constructors

DataShare' 

Fields

Instances

Instances details
Eq DataShare Source # 
Instance details

Defined in Amazonka.Redshift.Types.DataShare

Read DataShare Source # 
Instance details

Defined in Amazonka.Redshift.Types.DataShare

Show DataShare Source # 
Instance details

Defined in Amazonka.Redshift.Types.DataShare

Generic DataShare Source # 
Instance details

Defined in Amazonka.Redshift.Types.DataShare

Associated Types

type Rep DataShare :: Type -> Type #

NFData DataShare Source # 
Instance details

Defined in Amazonka.Redshift.Types.DataShare

Methods

rnf :: DataShare -> () #

Hashable DataShare Source # 
Instance details

Defined in Amazonka.Redshift.Types.DataShare

FromXML DataShare Source # 
Instance details

Defined in Amazonka.Redshift.Types.DataShare

type Rep DataShare Source # 
Instance details

Defined in Amazonka.Redshift.Types.DataShare

type Rep DataShare = D1 ('MetaData "DataShare" "Amazonka.Redshift.Types.DataShare" "libZSservicesZSamazonka-redshiftZSamazonka-redshift" 'False) (C1 ('MetaCons "DataShare'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "producerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dataShareAssociations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DataShareAssociation]))) :*: (S1 ('MetaSel ('Just "dataShareArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "allowPubliclyAccessibleConsumers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))

newDataShare :: DataShare Source #

Create a value of DataShare with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:producerArn:DataShare', dataShare_producerArn - The Amazon Resource Name (ARN) of the producer.

$sel:dataShareAssociations:DataShare', dataShare_dataShareAssociations - A value that specifies when the datashare has an association between a producer and data consumers.

$sel:dataShareArn:DataShare', dataShare_dataShareArn - An Amazon Resource Name (ARN) that references the datashare that is owned by a specific namespace of the producer cluster. A datashare ARN is in the arn:aws:redshift:{region}:{account-id}:{datashare}:{namespace-guid}/{datashare-name} format.

$sel:allowPubliclyAccessibleConsumers:DataShare', dataShare_allowPubliclyAccessibleConsumers - A value that specifies whether the datashare can be shared to a publicly accessible cluster.

Response Lenses

dataShare_producerArn :: Lens' DataShare (Maybe Text) Source #

The Amazon Resource Name (ARN) of the producer.

dataShare_dataShareAssociations :: Lens' DataShare (Maybe [DataShareAssociation]) Source #

A value that specifies when the datashare has an association between a producer and data consumers.

dataShare_dataShareArn :: Lens' DataShare (Maybe Text) Source #

An Amazon Resource Name (ARN) that references the datashare that is owned by a specific namespace of the producer cluster. A datashare ARN is in the arn:aws:redshift:{region}:{account-id}:{datashare}:{namespace-guid}/{datashare-name} format.

dataShare_allowPubliclyAccessibleConsumers :: Lens' DataShare (Maybe Bool) Source #

A value that specifies whether the datashare can be shared to a publicly accessible cluster.