Amazonka.Redshift.AssociateDataShareConsumer

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.

Creating a Request

data AssociateDataShareConsumer

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.

• consumerRegion :: Maybe Text

  From a datashare consumer account, associates a datashare with all existing and future namespaces in the specified Amazon Web Services Region.

• dataShareArn :: Text

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

Instances

ToHeaders AssociateDataShareConsumer

Defined in Amazonka.Redshift.AssociateDataShareConsumer

Methods

toHeaders :: AssociateDataShareConsumer -> [Header]

ToPath AssociateDataShareConsumer

Defined in Amazonka.Redshift.AssociateDataShareConsumer

Methods

toPath :: AssociateDataShareConsumer -> ByteString

ToQuery AssociateDataShareConsumer

Defined in Amazonka.Redshift.AssociateDataShareConsumer

Methods

toQuery :: AssociateDataShareConsumer -> QueryString

AWSRequest AssociateDataShareConsumer

Defined in Amazonka.Redshift.AssociateDataShareConsumer

Associated Types

type AWSResponse AssociateDataShareConsumer

Methods

request :: (Service -> Service) -> AssociateDataShareConsumer -> Request AssociateDataShareConsumer

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AssociateDataShareConsumer -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AssociateDataShareConsumer)))

Generic AssociateDataShareConsumer

Defined in Amazonka.Redshift.AssociateDataShareConsumer

Associated Types

type Rep AssociateDataShareConsumer :: Type -> Type

Methods

from :: AssociateDataShareConsumer -> Rep AssociateDataShareConsumer x

to :: Rep AssociateDataShareConsumer x -> AssociateDataShareConsumer

Read AssociateDataShareConsumer

Defined in Amazonka.Redshift.AssociateDataShareConsumer

Methods

readsPrec :: Int -> ReadS AssociateDataShareConsumer

readList :: ReadS [AssociateDataShareConsumer]

readPrec :: ReadPrec AssociateDataShareConsumer

readListPrec :: ReadPrec [AssociateDataShareConsumer]

Show AssociateDataShareConsumer

Defined in Amazonka.Redshift.AssociateDataShareConsumer

Methods

showsPrec :: Int -> AssociateDataShareConsumer -> ShowS

show :: AssociateDataShareConsumer -> String

showList :: [AssociateDataShareConsumer] -> ShowS

NFData AssociateDataShareConsumer

Defined in Amazonka.Redshift.AssociateDataShareConsumer

Methods

rnf :: AssociateDataShareConsumer -> ()

Eq AssociateDataShareConsumer

Defined in Amazonka.Redshift.AssociateDataShareConsumer

Methods

(==) :: AssociateDataShareConsumer -> AssociateDataShareConsumer -> Bool

(/=) :: AssociateDataShareConsumer -> AssociateDataShareConsumer -> Bool

Hashable AssociateDataShareConsumer

Defined in Amazonka.Redshift.AssociateDataShareConsumer

Methods

hashWithSalt :: Int -> AssociateDataShareConsumer -> Int

hash :: AssociateDataShareConsumer -> Int

type AWSResponse AssociateDataShareConsumer

Defined in Amazonka.Redshift.AssociateDataShareConsumer

type AWSResponse AssociateDataShareConsumer = DataShare

type Rep AssociateDataShareConsumer

Defined in Amazonka.Redshift.AssociateDataShareConsumer

type Rep AssociateDataShareConsumer = D1 ('MetaData "AssociateDataShareConsumer" "Amazonka.Redshift.AssociateDataShareConsumer" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" '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 "consumerRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dataShareArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newAssociateDataShareConsumer

Arguments

:: Text

AssociateDataShareConsumer

-> AssociateDataShareConsumer

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.

AssociateDataShareConsumer, associateDataShareConsumer_consumerRegion - From a datashare consumer account, associates a datashare with all existing and future namespaces in the specified Amazon Web Services Region.

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)

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

associateDataShareConsumer_consumerArn :: Lens' AssociateDataShareConsumer (Maybe Text)

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

associateDataShareConsumer_consumerRegion :: Lens' AssociateDataShareConsumer (Maybe Text)

From a datashare consumer account, associates a datashare with all existing and future namespaces in the specified Amazon Web Services Region.

associateDataShareConsumer_dataShareArn :: Lens' AssociateDataShareConsumer Text

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

See: newDataShare smart constructor.

Constructors

DataShare'

Fields

• allowPubliclyAccessibleConsumers :: Maybe Bool

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

• dataShareArn :: Maybe Text

  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.

• dataShareAssociations :: Maybe [DataShareAssociation]

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

• managedBy :: Maybe Text

  The identifier of a datashare to show its managing entity.

• producerArn :: Maybe Text

  The Amazon Resource Name (ARN) of the producer.

Instances

FromXML DataShare

Defined in Amazonka.Redshift.Types.DataShare

Methods

parseXML :: [Node] -> Either String DataShare

Generic DataShare

Defined in Amazonka.Redshift.Types.DataShare

Associated Types

type Rep DataShare :: Type -> Type

Methods

from :: DataShare -> Rep DataShare x

to :: Rep DataShare x -> DataShare

Read DataShare

Defined in Amazonka.Redshift.Types.DataShare

Methods

readsPrec :: Int -> ReadS DataShare

readList :: ReadS [DataShare]

readPrec :: ReadPrec DataShare

readListPrec :: ReadPrec [DataShare]

Show DataShare

Defined in Amazonka.Redshift.Types.DataShare

Methods

showsPrec :: Int -> DataShare -> ShowS

show :: DataShare -> String

showList :: [DataShare] -> ShowS

NFData DataShare

Defined in Amazonka.Redshift.Types.DataShare

Methods

rnf :: DataShare -> ()

Eq DataShare

Defined in Amazonka.Redshift.Types.DataShare

Methods

(==) :: DataShare -> DataShare -> Bool

(/=) :: DataShare -> DataShare -> Bool

Hashable DataShare

Defined in Amazonka.Redshift.Types.DataShare

Methods

hashWithSalt :: Int -> DataShare -> Int

hash :: DataShare -> Int

type Rep DataShare

Defined in Amazonka.Redshift.Types.DataShare

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

newDataShare :: DataShare

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:allowPubliclyAccessibleConsumers:DataShare', dataShare_allowPubliclyAccessibleConsumers - A value that specifies whether the datashare can be shared to a publicly accessible cluster.

$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:dataShareAssociations:DataShare', dataShare_dataShareAssociations - A value that specifies when the datashare has an association between producer and data consumers.

$sel:managedBy:DataShare', dataShare_managedBy - The identifier of a datashare to show its managing entity.

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

Response Lenses

dataShare_allowPubliclyAccessibleConsumers :: Lens' DataShare (Maybe Bool)

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

dataShare_dataShareArn :: Lens' DataShare (Maybe Text)

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_dataShareAssociations :: Lens' DataShare (Maybe [DataShareAssociation])

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

dataShare_managedBy :: Lens' DataShare (Maybe Text)

The identifier of a datashare to show its managing entity.

dataShare_producerArn :: Lens' DataShare (Maybe Text)

The Amazon Resource Name (ARN) of the producer.